diff options
author | rjones@thinkpad <rjones@thinkpad> | 2008-04-17 11:13:39 +0100 |
---|---|---|
committer | rjones@thinkpad <rjones@thinkpad> | 2008-04-17 11:13:39 +0100 |
commit | 5fb80987ddf0f8af6cd479964f1c5bb8340c7ba8 (patch) | |
tree | 6774d8d7c9fb2ec1b6f4b5913636f5e36af1dae2 /libvirt/README | |
parent | f9d99e63272520c19bddc9e4b47731d57e5658e2 (diff) | |
parent | f5f45d38269842b591a89ccaf2e6af7879d57aab (diff) | |
download | virt-top-5fb80987ddf0f8af6cd479964f1c5bb8340c7ba8.tar.gz virt-top-5fb80987ddf0f8af6cd479964f1c5bb8340c7ba8.tar.xz virt-top-5fb80987ddf0f8af6cd479964f1c5bb8340c7ba8.zip |
Merge.
Diffstat (limited to 'libvirt/README')
-rw-r--r-- | libvirt/README | 49 |
1 files changed, 0 insertions, 49 deletions
diff --git a/libvirt/README b/libvirt/README deleted file mode 100644 index be8300d..0000000 --- a/libvirt/README +++ /dev/null @@ -1,49 +0,0 @@ -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: - - #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. - -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. |