diff options
author | Richard W.M. Jones <rjones@redhat.com> | 2008-01-19 14:27:01 +0000 |
---|---|---|
committer | Richard W.M. Jones <rjones@redhat.com> | 2008-01-19 14:27:01 +0000 |
commit | 3a52f5d4f1becb1fc31eecf4a3a93542f2ff89b8 (patch) | |
tree | 9b8a26e8b929ac393475894338d23625b5f72145 /libvirt/README | |
parent | b6098f4c7419486227cbe2112904cbc9d58ed787 (diff) | |
download | virt-top-3a52f5d4f1becb1fc31eecf4a3a93542f2ff89b8.tar.gz virt-top-3a52f5d4f1becb1fc31eecf4a3a93542f2ff89b8.tar.xz virt-top-3a52f5d4f1becb1fc31eecf4a3a93542f2ff89b8.zip |
Documentation updates.
Diffstat (limited to 'libvirt/README')
-rw-r--r-- | libvirt/README | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/libvirt/README b/libvirt/README index c94cccb..be8300d 100644 --- a/libvirt/README +++ b/libvirt/README @@ -1,11 +1,29 @@ -README for generated code -------------------------- +README +====== + +The public interface is described in 'libvirt.mli'. You may prefer to +do 'make doc' at the top level source directory and then read the HTML +documentation starting at html/index.html. + +'libvirt.ml' describes how OCaml functions map to C functions. + +'libvirt_c*.c' are the C functions which map OCaml objects to C +objects and vice versa (see next section). + +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 majority of the functions are now generated automatically, but +there are a few one-off bindings (eg. one-of-a-type functions, +functions with particularly complex mappings). Our eventual aim to is +autogenerate as much as possible. Use 'make autostatus' in this +directory to find out how we're doing. + The generated 'libvirt_c.c' #includes some other C files in this directory: @@ -25,3 +43,7 @@ directory: An epilogue which defines some standard static functions (eg.) for wrapping and unwrapping libvirt objects. + +The key to understanding the generator is to look at the generated +code (libvirt_c.c) first, and go from there back to parts of the +generator script. |