summaryrefslogtreecommitdiffstats
path: root/libvirt/README
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2008-01-18 18:43:20 +0000
committerRichard W.M. Jones <rjones@redhat.com>2008-01-18 18:43:20 +0000
commit43b894e0ef93f380dcd8b1b20a3cd6626a8f3b7d (patch)
treeaa007bd306678022f2441ee290326c1a64d60027 /libvirt/README
parentebb4ff16c73674ef768674c85f600b71b63448e7 (diff)
downloadvirt-top-43b894e0ef93f380dcd8b1b20a3cd6626a8f3b7d.tar.gz
virt-top-43b894e0ef93f380dcd8b1b20a3cd6626a8f3b7d.tar.xz
virt-top-43b894e0ef93f380dcd8b1b20a3cd6626a8f3b7d.zip
Move to autogeneration of many C bindings.
* configure.ac, libvirt/libvirt_c.c, libvirt/generator.pl: Many C bindings can now be autogenerated using a Perl script. Also includes preliminary support for the experimental storage API.
Diffstat (limited to 'libvirt/README')
-rw-r--r--libvirt/README27
1 files changed, 27 insertions, 0 deletions
diff --git a/libvirt/README b/libvirt/README
new file mode 100644
index 0000000..c94cccb
--- /dev/null
+++ b/libvirt/README
@@ -0,0 +1,27 @@
+README for generated code
+-------------------------
+
+The C bindings in 'libvirt_c.c' are now generated automatically by a
+Perl script called 'generator.pl'. You do not normally need to run
+this script, but you may need to if you want to extend libvirt
+coverage.
+
+The generated 'libvirt_c.c' #includes some other C files in this
+directory:
+
+ #include "libvirt_c_prologue.c"
+
+ A prologue that prototypes some static functions which are defined
+ in the epilogue (see below), and provides some general macros.
+
+ #include "libvirt_c_oneoffs.c"
+
+ One-off bindings: Bindings which are too specialised or one-of-a-kind
+ to be worth generating automatically.
+
+ [Followed by generated bindings, then ...]
+
+ #include "libvirt_c_epilogue.c"
+
+ An epilogue which defines some standard static functions (eg.) for
+ wrapping and unwrapping libvirt objects.