[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 02/20] qapi: Fix indentation, again
From: |
Peter Maydell |
Subject: |
[PATCH v5 02/20] qapi: Fix indentation, again |
Date: |
Mon, 10 Aug 2020 20:50:01 +0100 |
In commit 26ec4e53f2 and similar commits we fixed the indentation
for doc comments in our qapi json files to follow a new stricter
standard for indentation, which permits only:
@arg: description line 1
description line 2
or:
@arg:
line 1
line 2
Unfortunately since we didn't manage to get the script changes that
enforced the new style in, a variety of commits (eg df4097aeaf71,
2e4457032105) introduced new doc text which doesn't follow the new
stricter rules for indentation on multi-line doc comments. Bring
those into line with the new rules.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qapi/audio.json | 12 ++++++------
qapi/block-core.json | 8 ++++----
qapi/control.json | 4 ++--
qapi/machine.json | 6 +++---
qapi/migration.json | 8 ++++----
qapi/misc.json | 4 ++--
qapi/net.json | 2 +-
7 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/qapi/audio.json b/qapi/audio.json
index f62bd0d7f6e..3b843878d23 100644
--- a/qapi/audio.json
+++ b/qapi/audio.json
@@ -159,20 +159,20 @@
# recording.
#
# @server-name: select from among several possible concurrent server instances
-# (default: environment variable $JACK_DEFAULT_SERVER if set, else "default")
+# (default: environment variable $JACK_DEFAULT_SERVER if set,
else "default")
#
# @client-name: the client name to use. The server will modify this name to
-# create a unique variant, if needed unless @exact-name is true (default: the
-# guest's name)
+# create a unique variant, if needed unless @exact-name is true
(default: the
+# guest's name)
#
# @connect-ports: if set, a regular expression of JACK client port name(s) to
-# monitor for and automatically connect to
+# monitor for and automatically connect to
#
# @start-server: start a jack server process if one is not already present
-# (default: false)
+# (default: false)
#
# @exact-name: use the exact name requested otherwise JACK automatically
-# generates a unique one, if needed (default: false)
+# generates a unique one, if needed (default: false)
#
# Since: 5.1
##
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 197bdc1c36d..f04bb3f0dd5 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -369,7 +369,7 @@
#
# Features:
# @deprecated: Member @encryption_key_missing is deprecated. It is
-# always false.
+# always false.
#
# Since: 0.14.0
#
@@ -504,7 +504,7 @@
#
# Features:
# @deprecated: Member @status is deprecated. Use @recording and
-# @locked instead.
+# @locked instead.
#
# Since: 1.3
##
@@ -614,7 +614,7 @@
#
# Features:
# @deprecated: Member @dirty-bitmaps is deprecated. Use @inserted
-# member @dirty-bitmaps instead.
+# member @dirty-bitmaps instead.
#
# Since: 0.14.0
##
@@ -1642,7 +1642,7 @@
#
# Features:
# @deprecated: Members @base and @top are deprecated. Use @base-node
-# and @top-node instead.
+# and @top-node instead.
#
# Returns: - Nothing on success
# - If @device does not exist, DeviceNotFound
diff --git a/qapi/control.json b/qapi/control.json
index de51e9916c3..134f842bafa 100644
--- a/qapi/control.json
+++ b/qapi/control.json
@@ -177,8 +177,8 @@
#
# Features:
# @deprecated: This command is deprecated, because its output doesn't
-# reflect compile-time configuration. Use 'query-qmp-schema'
-# instead.
+# reflect compile-time configuration. Use 'query-qmp-schema'
+# instead.
#
# Returns: A list of @EventInfo.
#
diff --git a/qapi/machine.json b/qapi/machine.json
index 481b1f07ecc..5aee2bbd169 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -191,8 +191,8 @@
#
# Features:
# @deprecated: This command is deprecated, because it interferes with
-# the guest. Use 'query-cpus-fast' instead to avoid the vCPU
-# interruption.
+# the guest. Use 'query-cpus-fast' instead to avoid the vCPU
+# interruption.
#
# Returns: a list of @CpuInfo for each virtual CPU
#
@@ -316,7 +316,7 @@
#
# Features:
# @deprecated: This command is deprecated. Use `device_add` instead.
-# See the `query-hotpluggable-cpus` command for details.
+# See the `query-hotpluggable-cpus` command for details.
#
# Returns: Nothing on success
#
diff --git a/qapi/migration.json b/qapi/migration.json
index e07c9c0f1aa..66a6fbb89d8 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1264,7 +1264,7 @@
#
# Features:
# @deprecated: This command is deprecated. Use
-# 'migrate-set-parameters' instead.
+# 'migrate-set-parameters' instead.
#
# Returns: nothing on success
#
@@ -1288,7 +1288,7 @@
#
# Features:
# @deprecated: This command is deprecated. Use
-# 'migrate-set-parameters' instead.
+# 'migrate-set-parameters' instead.
#
# Returns: nothing on success
#
@@ -1312,7 +1312,7 @@
#
# Features:
# @deprecated: This command is deprecated. Use
-# 'migrate-set-parameters' instead.
+# 'migrate-set-parameters' instead.
#
# The size will be rounded down to the nearest power of 2.
# The cache size can be modified before and during ongoing migration
@@ -1338,7 +1338,7 @@
#
# Features:
# @deprecated: This command is deprecated. Use
-# 'query-migrate-parameters' instead.
+# 'query-migrate-parameters' instead.
#
# Returns: XBZRLE cache size in bytes
#
diff --git a/qapi/misc.json b/qapi/misc.json
index 9d32820dc1b..8cf6ebe67cb 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -877,8 +877,8 @@
#
# Features:
# @deprecated: This command is deprecated. For changing block
-# devices, use 'blockdev-change-medium' instead; for changing VNC
-# parameters, use 'change-vnc-password' instead.
+# devices, use 'blockdev-change-medium' instead; for changing VNC
+# parameters, use 'change-vnc-password' instead.
#
# Returns: - Nothing on success.
# - If @device is not a valid block device, DeviceNotFound
diff --git a/qapi/net.json b/qapi/net.json
index ddb113e5e5a..a3a13360018 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -457,7 +457,7 @@
#
# Since: 2.7
#
-# @vhost-vdpa since 5.1
+# @vhost-vdpa since 5.1
##
{ 'enum': 'NetClientDriver',
'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
--
2.20.1
- [PATCH v5 00/20] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/08/10
- [PATCH v5 01/20] qapi/migration.json: Fix indentation, Peter Maydell, 2020/08/10
- [PATCH v5 02/20] qapi: Fix indentation, again,
Peter Maydell <=
- [PATCH v5 03/20] qapi/block-core.json: Fix nbd-server-start docs, Peter Maydell, 2020/08/10
- [PATCH v5 04/20] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/08/10
- [PATCH v5 05/20] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/08/10
- [PATCH v5 06/20] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Peter Maydell, 2020/08/10
- [PATCH v5 07/20] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/08/10
- [PATCH v5 08/20] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/08/10
- [PATCH v5 10/20] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/08/10
- [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/08/10