From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:58938) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dal44-0008Ge-FU for qemu-devel@nongnu.org; Thu, 27 Jul 2017 11:51:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dal41-0006Xl-7q for qemu-devel@nongnu.org; Thu, 27 Jul 2017 11:51:04 -0400 Received: from mx1.redhat.com ([209.132.183.28]:50360) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1dal40-0006Wy-VN for qemu-devel@nongnu.org; Thu, 27 Jul 2017 11:51:01 -0400 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 27 Jul 2017 17:41:12 +0200 Message-Id: <20170727154126.11339-13-marcandre.lureau@redhat.com> In-Reply-To: <20170727154126.11339-1-marcandre.lureau@redhat.com> References: <20170727154126.11339-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: [Qemu-devel] [PATCH 12/26] qapi2texi: add 'If:' section to generated documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Markus Armbruster , Michael Roth The documentation is generated only once, and doesn't know C pre-conditions. Signed-off-by: Marc-Andr=C3=A9 Lureau --- scripts/qapi2texi.py | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index 5aa2f48bfd..bfb8cd7c52 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -132,7 +132,6 @@ def texi_enum_value(value): """Format a table of members item for an enumeration value""" return '@item @code{%s}\n' % value.name =20 - def texi_member(member, suffix=3D''): """Format a table of members item for an object type member""" typ =3D member.type.doc_type() @@ -175,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 -def texi_sections(doc): +def texi_sections(doc, ifcond): """Format additional sections following arguments""" body =3D '' for section in doc.sections: @@ -189,14 +188,16 @@ def texi_sections(doc): body +=3D '\n\n@b{%s:}\n' % name =20 body +=3D func(doc) + if ifcond: + body +=3D '\n\n@b{If:} @code{%s}' % ifcond return body =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 class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor): @@ -213,7 +214,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor)= : self.out +=3D '\n' self.out +=3D TYPE_FMT(type=3D'Enum', name=3Ddoc.symbol, - body=3Dtexi_entity(doc, 'Values', + body=3Dtexi_entity(doc, 'Values', ifcond, member_func=3Dtexi_enum_va= lue)) =20 def visit_object_type(self, name, info, base, members, variants, ifc= ond): @@ -224,7 +225,8 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor)= : self.out +=3D '\n' self.out +=3D TYPE_FMT(type=3D'Object', name=3Ddoc.symbol, - body=3Dtexi_entity(doc, 'Members', base, va= riants)) + body=3Dtexi_entity(doc, 'Members', ifcond, + base, variants)) =20 def visit_alternate_type(self, name, info, variants, ifcond): doc =3D self.cur_doc @@ -232,7 +234,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor)= : self.out +=3D '\n' self.out +=3D TYPE_FMT(type=3D'Alternate', name=3Ddoc.symbol, - body=3Dtexi_entity(doc, 'Members')) + body=3Dtexi_entity(doc, 'Members', ifcond)) =20 def visit_command(self, name, info, arg_type, ret_type, gen, success_response, boxed, ifcond): @@ -242,9 +244,9 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor)= : if boxed: body =3D texi_body(doc) body +=3D '\n@b{Arguments:} the members of @code{%s}' % 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.out +=3D MSG_FMT(type=3D'Command', name=3Ddoc.symbol, body=3Dbody) @@ -255,7 +257,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor)= : self.out +=3D '\n' self.out +=3D MSG_FMT(type=3D'Event', name=3Ddoc.symbol, - body=3Dtexi_entity(doc, 'Arguments')) + body=3Dtexi_entity(doc, 'Arguments', ifcond)= ) =20 def symbol(self, doc, entity): self.cur_doc =3D doc @@ -266,7 +268,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor)= : assert not doc.args if self.out: self.out +=3D '\n' - self.out +=3D texi_body(doc) + texi_sections(doc) + self.out +=3D texi_body(doc) + texi_sections(doc, None) =20 =20 def texi_schema(schema): --=20 2.14.0.rc0.1.g40ca67566