From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:52823) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1faMmR-0000Qv-Iz for qemu-devel@nongnu.org; Tue, 03 Jul 2018 10:59:48 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1faMmM-00059f-Mz for qemu-devel@nongnu.org; Tue, 03 Jul 2018 10:59:47 -0400 Received: from mx3-rdu2.redhat.com ([66.187.233.73]:34440 helo=mx1.redhat.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1faMmM-00059P-HW for qemu-devel@nongnu.org; Tue, 03 Jul 2018 10:59:42 -0400 From: Markus Armbruster References: <20180627163551.31610-1-marcandre.lureau@redhat.com> <20180627163551.31610-14-marcandre.lureau@redhat.com> Date: Tue, 03 Jul 2018 16:59:40 +0200 In-Reply-To: <20180627163551.31610-14-marcandre.lureau@redhat.com> (=?utf-8?Q?=22Marc-Andr=C3=A9?= Lureau"'s message of "Wed, 27 Jun 2018 18:35:49 +0200") Message-ID: <87d0w48iw3.fsf@dusky.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Subject: Re: [Qemu-devel] [PATCH v6 13/15] qapi: add 'If:' section to generated documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: =?utf-8?Q?Marc-Andr=C3=A9?= Lureau Cc: qemu-devel@nongnu.org, Michael Roth , armbru@redhat.com, "Dr. David Alan Gilbert" , Gerd Hoffmann , Paolo Bonzini Marc-Andr=C3=A9 Lureau writes: > The documentation is generated only once, and doesn't know C > pre-conditions. Add 'If:' sections for top-level entities. > > Signed-off-by: Marc-Andr=C3=A9 Lureau > --- > scripts/qapi/doc.py | 22 ++++++++++++---------- > tests/qapi-schema/doc-good.json | 2 +- > tests/qapi-schema/doc-good.out | 1 + > tests/qapi-schema/doc-good.texi | 2 ++ > 4 files changed, 16 insertions(+), 11 deletions(-) > > diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py > index 4db6674dc3..987fd3c943 100755 > --- a/scripts/qapi/doc.py > +++ b/scripts/qapi/doc.py > @@ -174,7 +174,7 @@ def texi_members(doc, what, base, variants, member_fu= nc): > return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items) >=20=20 >=20=20 > -def texi_sections(doc): > +def texi_sections(doc, ifcond): > """Format additional sections following arguments""" > body =3D '' > for section in doc.sections: > @@ -185,14 +185,16 @@ def texi_sections(doc): > body +=3D texi_example(section.text) > else: > body +=3D texi_format(section.text) > + if ifcond: > + body +=3D '\n\n@b{If:} @code{%s}' % ", ".join(ifcond) > return body >=20=20 >=20=20 > -def texi_entity(doc, what, base=3DNone, variants=3DNone, > +def texi_entity(doc, what, ifcond, base=3DNone, variants=3DNone, > member_func=3Dtexi_member): > return (texi_body(doc) > + texi_members(doc, what, base, variants, member_func) > - + texi_sections(doc)) > + + texi_sections(doc, ifcond)) >=20=20 >=20=20 > class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaVisitor): > @@ -208,7 +210,7 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaV= isitor): > doc =3D self.cur_doc > self._gen.add(TYPE_FMT(type=3D'Enum', > name=3Ddoc.symbol, > - body=3Dtexi_entity(doc, 'Values', > + body=3Dtexi_entity(doc, 'Values', ifcond, > member_func=3Dtexi_enum_= value))) >=20=20 > def visit_object_type(self, name, info, ifcond, base, members, varia= nts): > @@ -217,14 +219,14 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchem= aVisitor): > base =3D None > self._gen.add(TYPE_FMT(type=3D'Object', > name=3Ddoc.symbol, > - body=3Dtexi_entity(doc, 'Members', > + body=3Dtexi_entity(doc, 'Members', ifcond, > base, variants))) >=20=20 > def visit_alternate_type(self, name, info, ifcond, variants): > doc =3D self.cur_doc > self._gen.add(TYPE_FMT(type=3D'Alternate', > name=3Ddoc.symbol, > - body=3Dtexi_entity(doc, 'Members'))) > + body=3Dtexi_entity(doc, 'Members', ifcond= ))) >=20=20 > def visit_command(self, name, info, ifcond, arg_type, ret_type, gen, > success_response, boxed, allow_oob, allow_preconfi= g): > @@ -233,9 +235,9 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaV= isitor): > body =3D texi_body(doc) > body +=3D ('\n@b{Arguments:} the members of @code{%s}\n' > % arg_type.name) > - body +=3D texi_sections(doc) > + body +=3D texi_sections(doc, ifcond) > else: > - body =3D texi_entity(doc, 'Arguments') > + body =3D texi_entity(doc, 'Arguments', ifcond) > self._gen.add(MSG_FMT(type=3D'Command', > name=3Ddoc.symbol, > body=3Dbody)) > @@ -244,7 +246,7 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaV= isitor): > doc =3D self.cur_doc > self._gen.add(MSG_FMT(type=3D'Event', > name=3Ddoc.symbol, > - body=3Dtexi_entity(doc, 'Arguments'))) > + body=3Dtexi_entity(doc, 'Arguments', ifcon= d))) >=20=20 > def symbol(self, doc, entity): > if self._gen._body: > @@ -257,7 +259,7 @@ class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaV= isitor): > assert not doc.args > if self._gen._body: > self._gen.add('\n') > - self._gen.add(texi_body(doc) + texi_sections(doc)) > + self._gen.add(texi_body(doc) + texi_sections(doc, None)) >=20=20 >=20=20 > def gen_doc(schema, output_dir, prefix): > diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good= .json > index 97ab4625ff..984cd8ed06 100644 > --- a/tests/qapi-schema/doc-good.json > +++ b/tests/qapi-schema/doc-good.json > @@ -55,7 +55,7 @@ > # > # @two is undocumented > ## > -{ 'enum': 'Enum', 'data': [ 'one', 'two' ] } > +{ 'enum': 'Enum', 'data': [ 'one', 'two' ], 'if': 'defined(IFCOND)' } >=20=20 > ## > # @Base: > diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.= out > index 9c8a4838e1..35f3f1164c 100644 > --- a/tests/qapi-schema/doc-good.out > +++ b/tests/qapi-schema/doc-good.out > @@ -3,6 +3,7 @@ enum QType ['none', 'qnull', 'qnum', 'qstring', 'qdict', = 'qlist', 'qbool'] > prefix QTYPE > module doc-good.json > enum Enum ['one', 'two'] > + if ['defined(IFCOND)'] > object Base > member base1: Enum optional=3DFalse > object Variant1 > diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good= .texi > index 0aed2300a5..e42eace474 100644 > --- a/tests/qapi-schema/doc-good.texi > +++ b/tests/qapi-schema/doc-good.texi > @@ -89,6 +89,8 @@ Not documented > @end table > @code{two} is undocumented >=20=20 > + > +@b{If:} @code{defined(IFCOND)} > @end deftp One blank line would be better, but that's as pervasive as it is minor. Reviewed-by: Markus Armbruster For the record, wanted follow-up work, from v5's review: * The big comment in qapi-schema.json should explain the documentation format, including the meaning of tags like 'If:', 'Since:' and so forth * Better test coverage