aboutsummaryrefslogtreecommitdiff
path: root/scripts/qapi2texi.py
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2017-03-15 13:57:18 +0100
committerMarkus Armbruster <armbru@redhat.com>2017-03-16 07:13:03 +0100
commit75b50196d9eee43f0b7d006455b9735ea5c3c333 (patch)
tree612b6338275ec08cdd03a3db25cbf42974ad9698 /scripts/qapi2texi.py
parentc19eaa64df7be01f060e04c0f13bba5de549c3f3 (diff)
qapi2texi: Use category "Object" for all object types
At the protocol level, the distinction between struct, flat union and simple union is meaningless, they are all JSON objects. Document them that way. Example change (qemu-qmp-ref.txt): - -- Simple Union: InputEvent + -- Object: InputEvent Input event union. This also fixes the completely broken headings for flat and simple unions in qemu-qmp-ref.7 and qemu-ga-ref.7, by sidestepping a bug in texi2pod.pl. For instance, it mistranslates "@deftp {Simple Union} InputEvent" to "B<Union> (Simple)", but translates "@deftp Object InputEvent" to "B<SocketAddress> (Object)". Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Message-Id: <1489582656-31133-30-git-send-email-armbru@redhat.com>
Diffstat (limited to 'scripts/qapi2texi.py')
-rwxr-xr-xscripts/qapi2texi.py8
1 files changed, 1 insertions, 7 deletions
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py
index 282adf46dc..8eed11a60c 100755
--- a/scripts/qapi2texi.py
+++ b/scripts/qapi2texi.py
@@ -219,17 +219,11 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):
def visit_object_type(self, name, info, base, members, variants):
doc = self.cur_doc
- if not variants:
- typ = 'Struct'
- elif variants._tag_name: # TODO unclean member access
- typ = 'Flat Union'
- else:
- typ = 'Simple Union'
if base and base.is_implicit():
base = None
if self.out:
self.out += '\n'
- self.out += TYPE_FMT(type=typ,
+ self.out += TYPE_FMT(type='Object',
name=doc.symbol,
body=texi_entity(doc, 'Members', base, variants))