From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org,
Richard Henderson <richard.henderson@linaro.org>
Subject: [PULL 4/5] qapi: Fix indentation, again
Date: Tue, 8 Sep 2020 08:54:16 +0200 [thread overview]
Message-ID: <20200908065417.3158250-5-armbru@redhat.com> (raw)
In-Reply-To: <20200908065417.3158250-1-armbru@redhat.com>
From: Peter Maydell <peter.maydell@linaro.org>
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>
Message-Id: <20200810195019.25427-3-peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
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 f62bd0d7f6..3b843878d2 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 55b58ba892..091f826f53 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -373,7 +373,7 @@
#
# Features:
# @deprecated: Member @encryption_key_missing is deprecated. It is
-# always false.
+# always false.
#
# Since: 0.14.0
#
@@ -508,7 +508,7 @@
#
# Features:
# @deprecated: Member @status is deprecated. Use @recording and
-# @locked instead.
+# @locked instead.
#
# Since: 1.3
##
@@ -618,7 +618,7 @@
#
# Features:
# @deprecated: Member @dirty-bitmaps is deprecated. Use @inserted
-# member @dirty-bitmaps instead.
+# member @dirty-bitmaps instead.
#
# Since: 0.14.0
##
@@ -1646,7 +1646,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 de51e9916c..134f842baf 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 abc6fd0477..0ac1880e4a 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 115181f4a5..675f70bb67 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1362,7 +1362,7 @@
#
# Features:
# @deprecated: This command is deprecated. Use
-# 'migrate-set-parameters' instead.
+# 'migrate-set-parameters' instead.
#
# Returns: nothing on success
#
@@ -1386,7 +1386,7 @@
#
# Features:
# @deprecated: This command is deprecated. Use
-# 'migrate-set-parameters' instead.
+# 'migrate-set-parameters' instead.
#
# Returns: nothing on success
#
@@ -1410,7 +1410,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
@@ -1436,7 +1436,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 9d32820dc1..8cf6ebe67c 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 ddb113e5e5..a3a1336001 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.26.2
next prev parent reply other threads:[~2020-09-08 6:57 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-08 6:54 [PULL 0/5] QAPI patches patches for 2020-09-08 Markus Armbruster
2020-09-08 6:54 ` [PULL 1/5] qapi: Reject section markup in definition documentation Markus Armbruster
2020-09-08 6:54 ` [PULL 2/5] qapi: Make section headings start a new doc comment block Markus Armbruster
2020-09-08 6:54 ` [PULL 3/5] qapi/migration.json: Fix indentation Markus Armbruster
2020-09-08 6:54 ` Markus Armbruster [this message]
2020-09-08 6:54 ` [PULL 5/5] qapi/block-core.json: Fix nbd-server-start docs Markus Armbruster
2020-09-08 17:23 ` [PULL 0/5] QAPI patches patches for 2020-09-08 Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200908065417.3158250-5-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).