From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, Eric Blake <eblake@redhat.com>
Subject: [PULL 6/8] qapi: Fix mangled "Returns" sections in documentation
Date: Fri, 26 Jan 2024 07:27:42 +0100 [thread overview]
Message-ID: <20240126062744.265588-7-armbru@redhat.com> (raw)
In-Reply-To: <20240126062744.265588-1-armbru@redhat.com>
Commit e050e426782e (qapi: Use explicit bulleted lists) added list
markup to correct bad rendering:
A JSON block comment like this:
Returns: nothing on success
If @node is not a valid block device, DeviceNotFound
If @name is not found, GenericError with an explanation
renders like this:
Returns: nothing on success If node is not a valid block device,
DeviceNotFound If name is not found, GenericError with an explanation
because whitespace is not significant.
Use an actual bulleted list, so that the formatting is correct.
It missed a few instances. Commit a937b6aa739 (qapi: Reformat doc
comments to conform to current conventions) then reflowed them.
Revert the reflowing, and add list markup.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240120095327.666239-6-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
qapi/net.json | 15 +++++++++------
qapi/qdev.json | 5 +++--
qapi/qom.json | 10 ++++++----
3 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/qapi/net.json b/qapi/net.json
index 8095b68fa8..68493d6ac9 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -18,8 +18,9 @@
#
# @up: true to set the link status to be up
#
-# Returns: Nothing on success If @name is not a valid network device,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @name is not a valid network device, DeviceNotFound
#
# Since: 0.14
#
@@ -44,8 +45,9 @@
#
# Since: 0.14
#
-# Returns: Nothing on success If @type is not a valid network backend,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @type is not a valid network backend, DeviceNotFound
#
# Example:
#
@@ -64,8 +66,9 @@
#
# @id: the name of the network backend to remove
#
-# Returns: Nothing on success If @id is not a valid network backend,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @id is not a valid network backend, DeviceNotFound
#
# Since: 0.14
#
diff --git a/qapi/qdev.json b/qapi/qdev.json
index 6bc5a733b8..25bac5e611 100644
--- a/qapi/qdev.json
+++ b/qapi/qdev.json
@@ -89,8 +89,9 @@
#
# @id: the device's ID or QOM path
#
-# Returns: Nothing on success If @id is not a valid device,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @id is not a valid device, DeviceNotFound
#
# Notes: When this command completes, the device may not be removed
# from the guest. Hot removal is an operation that requires guest
diff --git a/qapi/qom.json b/qapi/qom.json
index 95516ba325..84af23fe24 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -1056,8 +1056,9 @@
#
# Create a QOM object.
#
-# Returns: Nothing on success Error if @qom-type is not a valid class
-# name
+# Returns:
+# - Nothing on success
+# - Error if @qom-type is not a valid class name
#
# Since: 2.0
#
@@ -1078,8 +1079,9 @@
#
# @id: the name of the QOM object to remove
#
-# Returns: Nothing on success Error if @id is not a valid id for a QOM
-# object
+# Returns:
+# - Nothing on success
+# - Error if @id is not a valid id for a QOM object
#
# Since: 2.0
#
--
2.43.0
next prev parent reply other threads:[~2024-01-26 6:29 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-26 6:27 [PULL 0/8] QAPI patches patches for 2024-01-26 Markus Armbruster
2024-01-26 6:27 ` [PULL 1/8] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind' Markus Armbruster
2024-01-26 6:27 ` [PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs Markus Armbruster
2024-01-26 6:27 ` [PULL 3/8] docs: Replace dangling references to docs/interop/qmp-intro.txt Markus Armbruster
2024-01-26 6:27 ` [PULL 4/8] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt Markus Armbruster
2024-01-26 6:27 ` [PULL 5/8] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref Markus Armbruster
2024-01-26 6:27 ` Markus Armbruster [this message]
2024-01-26 6:27 ` [PULL 7/8] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-01-26 6:27 ` [PULL 8/8] qapi: Fix malformed "Since:" section tags (again) Markus Armbruster
2024-01-26 13:10 ` [PULL 0/8] QAPI patches patches for 2024-01-26 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=20240126062744.265588-7-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.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).