| Message ID | 1489385927-6735-30-git-send-email-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
On 03/13/2017 01:18 AM, Markus Armbruster wrote: > 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. Yay - and even addresses one of my comments earlier in the series about a needless distinction between simple and flat unions. > > 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> > --- > scripts/qapi2texi.py | 8 +------- > 1 file changed, 1 insertion(+), 7 deletions(-) > Reviewed-by: Eric Blake <eblake@redhat.com>
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))
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> --- scripts/qapi2texi.py | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-)