openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
libvirt/python
History
Daniel P. Berrange 5486abfe4e Fix API doc extractor to stop munging comment formatting 
The python method help docs are copied across from the C
funtion comments, but in the process all line breaks and
indentation was being lost. This made the resulting text
and code examples completely unreadable. Both the API
doc extractor and the python generator were destroying
whitespace & this fixes them to preserve it exactly.

* docs/apibuild.py: Preserve all whitespace when extracting
  function comments. Print function comment inside a <![CDATA[
  section to fully preserve all whitespace. Look for the
  word 'returns' to describe return values, instead of 'return'
  to avoid getting confused with code examples including the
  C 'return' statement.
* python/generator.py: Preserve all whitespace when printing
  function help docs
* src/libvirt.c: Change any return parameter indicated by
  'return' to be 'returns', to avoid confusing the API extractor
* docs/libvirt-api.xml: Re-build for fixed descriptions
 		2009-09-28 14:08:25 +01:00
..
tests remove all .cvsignore files 2009-07-08 16:17:51 +02:00
.gitignore Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00
Makefile.am Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00
README Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00
TODO syntax-check: enforce the no-cvs-keywords prohibition 2008-12-15 10:24:54 +00:00
generator.py Fix API doc extractor to stop munging comment formatting 2009-09-28 14:08:25 +01:00
libvirt-override-api.xml Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00
libvirt-override-virConnect.py Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00
libvirt-override.c Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00
libvirt-override.py Misc syntax-check fixes 2009-09-21 14:41:47 +01:00
typewrappers.c Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00
typewrappers.h Re-arrange python generator to make it clear what's auto-generated 2009-09-21 14:41:46 +01:00

README 

    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