c94cccb8b8d5a012187726776820835d5c8d8fe7
[virt-top.git] / libvirt / README
1 README for generated code
2 -------------------------
3
4 The C bindings in 'libvirt_c.c' are now generated automatically by a
5 Perl script called 'generator.pl'.  You do not normally need to run
6 this script, but you may need to if you want to extend libvirt
7 coverage.
8
9 The generated 'libvirt_c.c' #includes some other C files in this
10 directory:
11
12   #include "libvirt_c_prologue.c"
13
14     A prologue that prototypes some static functions which are defined
15     in the epilogue (see below), and provides some general macros.
16
17   #include "libvirt_c_oneoffs.c"
18
19     One-off bindings: Bindings which are too specialised or one-of-a-kind
20     to be worth generating automatically.
21
22   [Followed by generated bindings, then ...]
23
24   #include "libvirt_c_epilogue.c"
25
26     An epilogue which defines some standard static functions (eg.) for
27     wrapping and unwrapping libvirt objects.