[libvirt] [PATCH 2/2] python: Document virNodeGetInfo bug

[Michal Privoznik]

On 30.09.2013 11:38, Daniel P. Berrange wrote:
> On Mon, Sep 30, 2013 at 11:30:12AM +0200, Michal Privoznik wrote:
>> 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.
>>
>> Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
>> ---
>>  python/libvirt-override-api.xml | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/python/libvirt-override-api.xml b/python/libvirt-override-api.xml
>> index 1bceb05..337d0a0 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>
> 
> ACK

Thanks, I've pushed this patch even though we're in freeze as it's just
a documentation fix - so it won't break anything [Famous Last Words (TM)]

Michal