summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Blake <eblake@redhat.com>2014-06-25 14:54:36 -0600
committerEric Blake <eblake@redhat.com>2014-06-26 18:11:01 -0600
commite08ee660c3456e17995efca5f1d77b26b924abf6 (patch)
treee9b5dafae730d2d9ef896ba2102fa7886c28498a
parent6cb267e816fd89e0c362d5a090ec6c0539d5e730 (diff)
downloadlibvirt-e08ee660c3456e17995efca5f1d77b26b924abf6.tar.gz
docs: publish correct enum values
We publish libvirt-api.xml for others to use, and in fact, the libvirt-python bindings use it to generate python constants that correspond to our 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). 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. The python generator code has had the off-by-one ever since DV first wrote it years ago, but most of our public enums were immune because they had an explicit = 0 initializer. The only affected enums are: - virDomainEventGraphicsAddressType (such as VIR_DOMAIN_EVENT_GRAPHICS_ADDRESS_IPV4), since commit 987e31e (libvirt v0.8.0) - virDomainCoreDumpFormat (such as VIR_DOMAIN_CORE_DUMP_FORMAT_RAW), since commit 9fbaff0 (libvirt v1.2.3) - virIPAddrType (such as VIR_IP_ADDR_TYPE_IPV4), since commit 03e0e79 (not yet released) Thanks to Nehal J Wani for reporting the problem on IRC, and for helping me zero in on the culprit function. * docs/apibuild.py (CParser.parseEnumBlock): Fix implicit enum values. Signed-off-by: Eric Blake <eblake@redhat.com> (cherry picked from commit 9b291bbe20c36c0820c6e7cd2bf6229bf41807e8) Conflicts: docs/apibuild.py - context with 2a40951
-rwxr-xr-xdocs/apibuild.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/apibuild.py b/docs/apibuild.py
index df12ba6236..3d9f4723f5 100755
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -1303,7 +1303,7 @@ class CParser:
name = None
self.comment = None
comment = ""
- value = "0"
+ value = "-1"
while token != None:
if token[0] == "sep" and token[1] == "{":
token = self.token()