From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, jsnow@redhat.com, eblake@redhat.com,
kkostiuk@redhat.com
Subject: [PATCH 06/13] qapi: Clean up "Returns" sections
Date: Tue, 27 Feb 2024 12:39:14 +0100 [thread overview]
Message-ID: <20240227113921.236097-7-armbru@redhat.com> (raw)
In-Reply-To: <20240227113921.236097-1-armbru@redhat.com>
Drop list markup, since there's just one item left.
Drop "on success" where it is redundant with "Returns:".
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block-core.json | 4 ++--
qapi/machine.json | 4 ++--
qapi/misc.json | 2 +-
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 94b01deffc..1874f880a8 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -2457,7 +2457,7 @@
# @unstable: This command is meant for debugging.
#
# Returns:
-# - BlockDirtyBitmapSha256 on success
+# BlockDirtyBitmapSha256
#
# Errors:
# - If @node is not a valid block device, DeviceNotFound
@@ -6084,7 +6084,7 @@
# @name: optional the snapshot's name to be deleted
#
# Returns:
-# - SnapshotInfo on success
+# SnapshotInfo
#
# Errors:
# - If @device is not a valid block device, GenericError
diff --git a/qapi/machine.json b/qapi/machine.json
index 7d3ca33683..bb5a178909 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1090,7 +1090,7 @@
# Return information about the balloon device.
#
# Returns:
-# - @BalloonInfo on success
+# @BalloonInfo
#
# Errors:
# - If the balloon driver is enabled but not functional because
@@ -1156,7 +1156,7 @@
# message from the guest.
#
# Returns:
-# - @HvBalloonInfo on success
+# @HvBalloonInfo
#
# Errors:
# - If no hv-balloon device is present, guest memory status
diff --git a/qapi/misc.json b/qapi/misc.json
index 015388aa3e..1b0c5dad88 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -332,7 +332,7 @@
# @opaque: A free-form string that can be used to describe the fd.
#
# Returns:
-# - @AddfdInfo on success
+# @AddfdInfo
#
# Errors:
# - If file descriptor was not received, GenericError
--
2.43.0
next prev parent reply other threads:[~2024-02-27 11:41 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-27 11:39 [PATCH 00/13] Subject: [PATCH 00/15] qapi: Improve command response documentation Markus Armbruster
2024-02-27 11:39 ` [PATCH 01/13] qapi: Memorize since & returns sections Markus Armbruster
2024-02-27 11:39 ` [PATCH 02/13] qapi: Slightly clearer error message for invalid "Returns" section Markus Armbruster
2024-02-27 11:39 ` [PATCH 03/13] qapi: New documentation section tag "Errors" Markus Armbruster
2024-02-27 11:39 ` [PATCH 04/13] qapi: Move error documentation to new "Errors" sections Markus Armbruster
2024-02-27 11:39 ` [PATCH 05/13] qapi: Delete useless "Returns" sections Markus Armbruster
2024-02-27 11:39 ` Markus Armbruster [this message]
2024-02-27 11:39 ` [PATCH 07/13] qapi/yank: Tweak @yank's error description for consistency Markus Armbruster
2024-02-27 11:39 ` [PATCH 08/13] qga/qapi-schema: Move error documentation to new "Errors" sections Markus Armbruster
2024-03-04 8:23 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 09/13] qga/qapi-schema: Delete useless "Returns" sections Markus Armbruster
2024-03-04 8:25 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 10/13] qga/qapi-schema: Clean up " Markus Armbruster
2024-03-04 8:24 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 11/13] qga/qapi-schema: Tweak documentation of fsfreeze commands Markus Armbruster
2024-03-04 8:21 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 12/13] qga/qapi-schema: Fix guest-set-memory-blocks documentation Markus Armbruster
2024-03-04 8:16 ` Konstantin Kostiuk
2024-02-27 11:39 ` [PATCH 13/13] qapi: Reject "Returns" section when command doesn't return anything Markus Armbruster
2024-03-11 15:37 ` [PATCH 00/13] Subject: [PATCH 00/15] qapi: Improve command response documentation Konstantin Kostiuk
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=20240227113921.236097-7-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=jsnow@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=michael.roth@amd.com \
--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).