From: Michal Privoznik <mprivozn@redhat.com>
Date: Mon, 30 Sep 2013 09:23:08 +0000 (+0200)
Subject: python: Document virNodeGetInfo bug
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=f113ce611b8cd19eb6c8b3cda29be083a5a51a69;p=libvirt.git

python: Document virNodeGetInfo bug

The memory size in virNodeGetInfo python API binding is reported in MiB
instead of KiB (like we have in C struct). However, there already might
be applications out there relying on this inconsistence so we can't
simply fix it. Document this sad fact as known bug.
---

diff --git a/python/libvirt-override-api.xml b/python/libvirt-override-api.xml
index 1bceb0502e..337d0a093f 100644
--- a/python/libvirt-override-api.xml
+++ b/python/libvirt-override-api.xml
@@ -100,7 +100,7 @@
       <arg name='flags' type='unsigned int' info='flags, currently unused, pass 0.'/>
     </function>
     <function name='virNodeGetInfo' file='python'>
-      <info>Extract hardware information about the Node.</info>
+      <info>Extract hardware information about the Node. Note that the memory size is reported in MiB instead of KiB.</info>
       <return type='char *' info='the list of information or None in case of error'/>
       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
     </function>