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 1bceb0502e9c20aaacbbe57485a81ed87d45bffe..337d0a093fdc6451e2503b0c600e0ab937eec215 100644 (file)
--- 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>