[libvirt] [PATCH] docs: publish correct enum values

[Eric Blake]

On 06/25/2014 05:23 PM, Eric Blake wrote:
> On 06/25/2014 03:09 PM, Eric Blake wrote:
>> We publish libvirt-api.xml for others to use, and in fact, the
>> libvirt-python bindings use it to generate enum values.  However,
>> we had an off-by-one bug that any enum that relied on C's rules
>> for implicit initialization of the first enum member to 0 got
>> listed in the xml as having a value of 1 (and all later members
>> of the enum were equally botched).
>>
>> Affected are:
>> - virDomainCoreDumpFormat (such as VIR_DOMAIN_CORE_DUMP_FORMAT_RAW),
>> since libvirt TBD
> 
> commit 9fbaff0 v1.2.3
> 
>> - virDomainEventGraphicsAddressType (such as
>> VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4), since libvirt TBD
> 
> commit 987e31e v0.8.0
> 
>> - virIPAddrType (such as VIR_IP_ADDR_TYPE_IPV4), since libvirt TBD
> 
> commit 03e0e79, not yet released
> 
>>
>> The fix is simple - since we add one to the previous value when
>> encountering an enum without an initializer, the previous value
>> must start at -1 so that the first enum member is assigned 0.
>>
>> Thanks to Nehal J Wani for reporting the problem on IRC, and
>> for helping me zero in on the culprit function.

Nehal reported on IRC that this fixed the problem, so I'm pushing the
patch, and backporting to the maint branches.

>>
>> * docs/apibuild.py (CParser.parseEnumBlock): Fix implicit enum
>> values.
>>
>> Signed-off-by: Eric Blake <eblake at redhat.com>
>> ---
>>
>> I'm going to touch up the commit message before pushing, once I
>> do enough research on which versions of libvirt were impacted;
>> but I just got interrupted, so I'm posting this now to get the
>> review started.
> 
> Research done.  Bummer that our graphics event python bindings have been
> broken since 0.8.0 :(
> 

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 604 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20140626/7adcc6af/attachment-0001.sig>