Re: [libvirt] [PATCH libvirt-python] Update README file contents and add HACKING file
On 11/25/2013 10:18 AM, Daniel P. Berrange wrote:
From: "Daniel P. Berrange" <berrange(a)redhat.com>
The previous README file from the python code is more like a
HACKING file. Rename it and update the content. Then add a
basic README file
Signed-off-by: Daniel P. Berrange <berrange(a)redhat.com>
---
HACKING | 37 +++++++++++++++++++++++++++++++++++++
README | 41 +++++++++++++++++++++--------------------
2 files changed, 58 insertions(+), 20 deletions(-)
create mode 100644 HACKING
diff --git a/HACKING b/HACKING
+
+Most of the libvirt python binding code is automatically generated
+using the script generator.py, and the API description that the
is 2 spaces intentional?
+libvirt library installs into /usr/share (or wherever the following
+command says.
No closing ')'; but I'm not sure on how best to reword to fix that. Maybe:
installs into the location shown by pkg-config (defaults to /usr/share)
with this command:
+
+ $ pkg-config --variable libvirt_api libvirt
+ /usr/share/libvirt/api/libvirt-api.xml
+
+
+Some of the API descriptions in the primary XML files are not directlry
s/directlry/directly/
+usable by the code generator. Thus there are overrides in
+
+ - libvirt-override-api.xml
+ - libvirt-qemu-override-api.xml
+ - libvirt-lxc-override-api.xml
+
+For stuff which the genrator can't cope with at all there are some
s/genrator/generator/
+++ b/README
@@ -1,27 +1,28 @@
+The module can be built by following the normal python module
+build processs
s/processs/process/
+Patches for this code should be sent to the main libvirt
+development mailing list
+
+ http://libvirt.org/contact.html#email
Maybe mention 'git config format.subjectprefix "python PATCH"' so that
we get visual indication when a patch is for python.
ACK with grammar cleaned up.
--
Eric Blake eblake redhat com +1-919-301-3266
Libvirt virtualization library http://libvirt.org
Attachments:
- signature.asc (application/pgp-signature — 621 bytes)