From mboxrd@z Thu Jan 1 00:00:00 1970 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 From: Markus Armbruster 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> Subject: [Qemu-devel] [PATCH for-2.9 24/47] qapi2texi: Implement boxed argument documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: marcandre.lureau@redhat.com, eblake@redhat.com, mdroth@linux.vnet.ibm.com 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 --- 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='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 = self.cur_doc if self.out: self.out += '\n' + if boxed: + body = texi_body(doc) + body += '\n@b{Arguments:} the members of @code{%s}' % arg_type.name + body += texi_sections(doc) + else: + body = texi_entity(doc, 'Arguments') self.out += MSG_FMT(type='Command', name=doc.symbol, - body=texi_entity(doc, 'Arguments')) + body=body) def visit_event(self, name, info, arg_type, boxed): doc = self.cur_doc -- 2.7.4