[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for a
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for all object types |
Date: |
Thu, 16 Mar 2017 07:27:47 +0100 |
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 <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
---
scripts/qapi2texi.py | 8 +-------
1 file changed, 1 insertion(+), 7 deletions(-)
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py
index 282adf4..8eed11a 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))
--
2.7.4
- [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage, (continued)
- [Qemu-devel] [PULL for 2.9 32/49] tests/qapi-schema: Improve doc / expression mismatch coverage, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 21/49] qapi: Prefer single-quoted strings more consistently, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 29/49] qapi2texi: Generate documentation for variant members, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 18/49] qapi2texi: Convert to QAPISchemaVisitor, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 48/49] qapi: Make pylint a bit happier, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 15/49] qapi: Fix QAPISchemaEnumType.is_implicit() for 'QType', Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 13/49] qapi: Avoid unwanted blank lines in QAPIDoc, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 25/49] qapi2texi: Don't hide undocumented members and arguments, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 30/49] qapi2texi: Generate descriptions for simple union tags, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 41/49] qapi: Drop unused variable events, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 31/49] qapi2texi: Use category "Object" for all object types,
Markus Armbruster <=
- [Qemu-devel] [PULL for 2.9 35/49] qapi: Improve error message on @NAME: in free-form doc, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 22/49] qapi2texi: Plainer enum value and member name formatting, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 33/49] qapi: Fix detection of doc / expression mismatch, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 23/49] qapi2texi: Present the table of members more clearly, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 36/49] qapi: Move empty doc section checking to doc parser, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 42/49] qapi: Simplify what gets stored in enum_types, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 34/49] qapi: Move detection of doc / expression name mismatch, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 46/49] qapi: union_types is a list used like a dict, make it one, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 45/49] qapi: struct_types is a list used like a dict, make it one, Markus Armbruster, 2017/03/16
- [Qemu-devel] [PULL for 2.9 38/49] tests/qapi-schema: Improve coverage of bogus member docs, Markus Armbruster, 2017/03/16