diff options
| author | Daniel P. Berrange <berrange@redhat.com> | 2009-09-16 14:03:53 +0100 |
|---|---|---|
| committer | Daniel P. Berrange <berrange@redhat.com> | 2009-09-21 14:41:46 +0100 |
| commit | a9ea906035bcf5cbe95db64f51ed2ff7cec2b503 (patch) | |
| tree | 0f55b2a22a6e4b44ec5c41b267839f82757090af /README | |
| parent | a5bab7085e42d87561c817f91c26def384611f2e (diff) | |
| download | libvirt-python-v6-a9ea906035bcf5cbe95db64f51ed2ff7cec2b503.tar.gz libvirt-python-v6-a9ea906035bcf5cbe95db64f51ed2ff7cec2b503.tar.xz libvirt-python-v6-a9ea906035bcf5cbe95db64f51ed2ff7cec2b503.zip | |
Re-arrange python generator to make it clear what's auto-generated
* README: New file describing what each file is used for
* livvirt-override.c, libvirt-override.py, libvirt-override-api.xml,
libvirt-override-virConnect.py: Manually written code overriding
the generator
* typewrappers.c, typewrappers.h: Data type wrappers
* generator.py: Automatically pre-prend contents of libvirt-override.py
to generated libvirt.py. Output into libvirt.py directly instead of
libvirtclass.py. Don't generate libvirtclass.txt at all. Write C
files into libvirt.c/.h directly
* Makefile.am: Remove rule for creating libvirt.py from libvirt-override.py
and libvirtclass.py, since generator.py does it directly
Diffstat (limited to 'README')
| -rw-r--r-- | README | 27 |
1 files changed, 27 insertions, 0 deletions
@@ -0,0 +1,27 @@ + libvirt Python Bindings README + ============================== + +Most of the libvirt python binding code is automatically generated +using the script generator.py, and the API description from +docs/libvirt-api.xml + + +Manually written files: + + - libvirt-override.c: methods where the C binding needs to be hand crafted + - libvirt-override.py: global methods where the C and python bindings have different args + - libvirt-override-api.xml: methods where the auto-extracted API docs are not + suitable for python auto-generator. Overriding this if the method is going + into libvirt-override.c, but we still want auto-generated libvirt-override.py + - libvirt-override-virConnect.py: virConnect class methods + - typewrappers.h,.c: Python object wrappers for each libvirt C object + + +Auto-generated files: + + - libvirt.py: The main python binding. Comprises auto-generated code, along + with contents from libvirt-override.py and libvirt-override-virConnect.py + - libvirt.c, libvirt.h: The C glue layer for the python binding. Comprises + auto-generated code, along with libvirt-override.c + - libvirt-export.c: List of auto-generated C methods, included into + the libvirt-override.c method table |