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 <arm...@redhat.com>
Reviewed-by: Eric Blake <ebl...@redhat.com>
Message-Id: <1489582656-31133-25-git-send-email-arm...@redhat.com>
---
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 1be1ec5..0f132fc 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1341,8 +1341,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
#
@@ -1369,8 +1367,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
#
@@ -1458,8 +1454,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
#
@@ -1731,8 +1725,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
#
@@ -2915,8 +2907,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
