From nobody Thu Nov 6 16:07:59 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1489386874906796.4685244173489; Sun, 12 Mar 2017 23:34:34 -0700 (PDT) Received: from localhost ([::1]:50420 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cnJYv-0002xJ-Ia for importer@patchew.org; Mon, 13 Mar 2017 02:34:33 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:52297) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cnJJo-0007YV-1b for qemu-devel@nongnu.org; Mon, 13 Mar 2017 02:19:02 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cnJJl-0003ba-Ks for qemu-devel@nongnu.org; Mon, 13 Mar 2017 02:18:55 -0400 Received: from mx1.redhat.com ([209.132.183.28]:41068) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cnJJl-0003Ze-4a for qemu-devel@nongnu.org; Mon, 13 Mar 2017 02:18:53 -0400 Received: from smtp.corp.redhat.com (int-mx16.intmail.prod.int.phx2.redhat.com [10.5.11.28]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 57FC281222; Mon, 13 Mar 2017 06:18:53 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-55.ams2.redhat.com [10.36.116.55]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1E3622D5C7; Mon, 13 Mar 2017 06:18:53 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 6539511384AE; Mon, 13 Mar 2017 07:18:47 +0100 (CET) From: Markus Armbruster To: qemu-devel@nongnu.org Date: Mon, 13 Mar 2017 07:18:24 +0100 Message-Id: <1489385927-6735-25-git-send-email-armbru@redhat.com> In-Reply-To: <1489385927-6735-1-git-send-email-armbru@redhat.com> References: <1489385927-6735-1-git-send-email-armbru@redhat.com> X-Scanned-By: MIMEDefang 2.74 on 10.5.11.28 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.25]); Mon, 13 Mar 2017 06:18:53 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH for-2.9 24/47] qapi2texi: Implement boxed argument documentation X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: marcandre.lureau@redhat.com, mdroth@linux.vnet.ibm.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" This replaces manual references like "For the arguments, see the documentation of ..." by a generated reference "Arguments: the members of ...". Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake --- qapi-schema.json | 2 +- qapi/block-core.json | 10 ---------- scripts/qapi2texi.py | 8 +++++++- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/qapi-schema.json b/qapi-schema.json index d693033..1d7b1cd 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -1017,7 +1017,7 @@ ## # @migrate-set-parameters: # -# Set various migration parameters. See MigrationParameters for details. +# Set various migration parameters. # # Since: 2.4 # diff --git a/qapi/block-core.json b/qapi/block-core.json index 539649c..83601db 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1340,8 +1340,6 @@ # The operation can be stopped before it has completed using the # block-job-cancel command. # -# For the arguments, see the documentation of DriveBackup. -# # Returns: nothing on success # If @device is not a valid block device, GenericError # @@ -1368,8 +1366,6 @@ # The operation can be stopped before it has completed using the # block-job-cancel command. # -# For the arguments, see the documentation of BlockdevBackup. -# # Returns: nothing on success # If @device is not a valid block device, DeviceNotFound # @@ -1457,8 +1453,6 @@ # format of the mirror image, default is to probe if mode=3D'existing', # else the format of the source. # -# See DriveMirror for parameter descriptions -# # Returns: nothing on success # If @device is not a valid block device, GenericError # @@ -1730,8 +1724,6 @@ # the device will be removed from its group and the rest of its # members will not be affected. The 'group' parameter is ignored. # -# See BlockIOThrottle for parameter descriptions. -# # Returns: Nothing on success # If @device is not a valid block device, DeviceNotFound # @@ -2944,8 +2936,6 @@ # BlockBackend will be created; otherwise, @node-name is mandatory at the = top # level and no BlockBackend will be created. # -# For the arguments, see the documentation of BlockdevOptions. -# # Note: This command is still a work in progress. It doesn't support all # block drivers among other things. Stay away from it unless you want # to help with its development. diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index df87441..3dd0146 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -220,9 +220,15 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor): doc =3D self.cur_doc if self.out: self.out +=3D '\n' + if boxed: + body =3D texi_body(doc) + body +=3D '\n@b{Arguments:} the members of @code{%s}' % arg_ty= pe.name + body +=3D texi_sections(doc) + else: + body =3D texi_entity(doc, 'Arguments') self.out +=3D MSG_FMT(type=3D'Command', name=3Ddoc.symbol, - body=3Dtexi_entity(doc, 'Arguments')) + body=3Dbody) =20 def visit_event(self, name, info, arg_type, boxed): doc =3D self.cur_doc --=20 2.7.4