{"id":812328,"url":"http://patchwork.ozlabs.org/api/patches/812328/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170911110623.24981-33-marcandre.lureau@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170911110623.24981-33-marcandre.lureau@redhat.com>","list_archive_url":null,"date":"2017-09-11T11:06:05","name":"[v3,32/50] qapi2texi: add 'If:' section to generated documentation","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"45692c5d8a3133e81b51d64cbaab6222bc6aa125","submitter":{"id":66774,"url":"http://patchwork.ozlabs.org/api/people/66774/?format=json","name":"Marc-André Lureau","email":"marcandre.lureau@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170911110623.24981-33-marcandre.lureau@redhat.com/mbox/","series":[{"id":2480,"url":"http://patchwork.ozlabs.org/api/series/2480/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=2480","date":"2017-09-11T11:05:33","name":"Hi,","version":3,"mbox":"http://patchwork.ozlabs.org/series/2480/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/812328/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/812328/checks/","tags":{},"related":[],"headers":{"Return-Path":"","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=)","ext-mx09.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx09.extmail.prod.ext.phx2.redhat.com;\n\tspf=fail smtp.mailfrom=marcandre.lureau@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xrQQf5j7Hz9s7G\n\tfor ;\n\tMon, 11 Sep 2017 21:18:18 +1000 (AEST)","from localhost ([::1]:56788 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t)\n\tid 1drMjI-0006Jr-Qk\n\tfor incoming@patchwork.ozlabs.org; Mon, 11 Sep 2017 07:18:16 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:43419)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from ) id 1drMZD-00065o-Eu\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 07:07:55 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from ) id 1drMZC-0006um-64\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 07:07:51 -0400","from mx1.redhat.com ([209.132.183.28]:49022)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from )\n\tid 1drMZB-0006uM-Us\n\tfor qemu-devel@nongnu.org; Mon, 11 Sep 2017 07:07:50 -0400","from smtp.corp.redhat.com\n\t(int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby mx1.redhat.com (Postfix) with ESMTPS id 24FF2CD678;\n\tMon, 11 Sep 2017 11:07:49 +0000 (UTC)","from localhost (ovpn-112-47.ams2.redhat.com [10.36.112.47])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id ACEAF649CC;\n\tMon, 11 Sep 2017 11:07:48 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com 24FF2CD678","From":"=?utf-8?q?Marc-Andr=C3=A9_Lureau?= ","To":"qemu-devel@nongnu.org","Date":"Mon, 11 Sep 2017 13:06:05 +0200","Message-Id":"<20170911110623.24981-33-marcandre.lureau@redhat.com>","In-Reply-To":"<20170911110623.24981-1-marcandre.lureau@redhat.com>","References":"<20170911110623.24981-1-marcandre.lureau@redhat.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.11","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.38]);\n\tMon, 11 Sep 2017 11:07:49 +0000 (UTC)","Content-Transfer-Encoding":"quoted-printable","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"209.132.183.28","Subject":"[Qemu-devel] [PATCH v3 32/50] qapi2texi: add 'If:' section to\n\tgenerated documentation","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Cc":"=?utf-8?q?Marc-Andr=C3=A9_Lureau?= ,\n\tarmbru@redhat.com, Michael Roth ","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t"},"content":"The documentation is generated only once, and doesn't know C\npre-conditions. Add 'If:' sections for top-level entities.\n\nSigned-off-by: Marc-André Lureau \n---\n scripts/qapi2texi.py | 24 +++++++++++++-----------\n 1 file changed, 13 insertions(+), 11 deletions(-)","diff":"diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py\nindex e72e7cfe0b..150e7045d2 100755\n--- a/scripts/qapi2texi.py\n+++ b/scripts/qapi2texi.py\n@@ -132,7 +132,6 @@ def texi_enum_value(value):\n \"\"\"Format a table of members item for an enumeration value\"\"\"\n return '@item @code{%s}\\n' % value.name\n \n-\n def texi_member(member, suffix=''):\n \"\"\"Format a table of members item for an object type member\"\"\"\n typ = member.type.doc_type()\n@@ -175,7 +174,7 @@ def texi_members(doc, what, base, variants, member_func):\n return '\\n@b{%s:}\\n@table @asis\\n%s@end table\\n' % (what, items)\n \n \n-def texi_sections(doc):\n+def texi_sections(doc, ifcond):\n \"\"\"Format additional sections following arguments\"\"\"\n body = ''\n for section in doc.sections:\n@@ -189,14 +188,16 @@ def texi_sections(doc):\n body += '\\n\\n@b{%s:}\\n' % name\n \n body += func(doc)\n+ if ifcond:\n+ body += '\\n\\n@b{If:} @code{%s}' % ifcond\n return body\n \n \n-def texi_entity(doc, what, base=None, variants=None,\n+def texi_entity(doc, what, ifcond, base=None, variants=None,\n member_func=texi_member):\n return (texi_body(doc)\n + texi_members(doc, what, base, variants, member_func)\n- + texi_sections(doc))\n+ + texi_sections(doc, ifcond))\n \n \n class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):\n@@ -213,7 +214,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):\n self.out += '\\n'\n self.out += TYPE_FMT(type='Enum',\n name=doc.symbol,\n- body=texi_entity(doc, 'Values',\n+ body=texi_entity(doc, 'Values', ifcond,\n member_func=texi_enum_value))\n \n def visit_object_type(self, name, info, ifcond, base, members, variants):\n@@ -224,7 +225,8 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):\n self.out += '\\n'\n self.out += TYPE_FMT(type='Object',\n name=doc.symbol,\n- body=texi_entity(doc, 'Members', base, variants))\n+ body=texi_entity(doc, 'Members', ifcond,\n+ base, variants))\n \n def visit_alternate_type(self, name, info, ifcond, variants):\n doc = self.cur_doc\n@@ -232,7 +234,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):\n self.out += '\\n'\n self.out += TYPE_FMT(type='Alternate',\n name=doc.symbol,\n- body=texi_entity(doc, 'Members'))\n+ body=texi_entity(doc, 'Members', ifcond))\n \n def visit_command(self, name, info, ifcond, arg_type, ret_type,\n gen, success_response, boxed):\n@@ -242,9 +244,9 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):\n if boxed:\n body = texi_body(doc)\n body += '\\n@b{Arguments:} the members of @code{%s}' % arg_type.name\n- body += texi_sections(doc)\n+ body += texi_sections(doc, ifcond)\n else:\n- body = texi_entity(doc, 'Arguments')\n+ body = texi_entity(doc, 'Arguments', ifcond)\n self.out += MSG_FMT(type='Command',\n name=doc.symbol,\n body=body)\n@@ -255,7 +257,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):\n self.out += '\\n'\n self.out += MSG_FMT(type='Event',\n name=doc.symbol,\n- body=texi_entity(doc, 'Arguments'))\n+ body=texi_entity(doc, 'Arguments', ifcond))\n \n def symbol(self, doc, entity):\n self.cur_doc = doc\n@@ -266,7 +268,7 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):\n assert not doc.args\n if self.out:\n self.out += '\\n'\n- self.out += texi_body(doc) + texi_sections(doc)\n+ self.out += texi_body(doc) + texi_sections(doc, None)\n \n \n def texi_schema(schema):\n","prefixes":["v3","32/50"]}