qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
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 10/13] qga/qapi-schema: Clean up "Returns" sections
Date: Tue, 27 Feb 2024 12:39:18 +0100	[thread overview]
Message-ID: <20240227113921.236097-11-armbru@redhat.com> (raw)
In-Reply-To: <20240227113921.236097-1-armbru@redhat.com>

Drop "on success" where it is redundant with "Returns:".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qga/qapi-schema.json | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 636c2c5697..326d324901 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -228,7 +228,7 @@
 #
 # @mode: open mode, as per fopen(), "r" is the default.
 #
-# Returns: Guest file handle on success.
+# Returns: Guest file handle
 #
 # Since: 0.15.0
 ##
@@ -277,7 +277,7 @@
 # @count: maximum number of bytes to read (default is 4KB, maximum is
 #     48MB)
 #
-# Returns: @GuestFileRead on success.
+# Returns: @GuestFileRead
 #
 # Since: 0.15.0
 ##
@@ -312,7 +312,7 @@
 # @count: bytes to write (actual bytes, after base64-decode), default
 #     is all content in buf-b64 buffer after base64 decoding
 #
-# Returns: @GuestFileWrite on success.
+# Returns: @GuestFileWrite
 #
 # Since: 0.15.0
 ##
@@ -379,7 +379,7 @@
 #
 # @whence: Symbolic or numeric code for interpreting offset
 #
-# Returns: @GuestFileSeek on success.
+# Returns: @GuestFileSeek
 #
 # Since: 0.15.0
 ##
@@ -723,7 +723,7 @@
 #
 # Get list of guest IP addresses, MAC addresses and netmasks.
 #
-# Returns: List of GuestNetworkInterface on success.
+# Returns: List of GuestNetworkInterface
 #
 # Since: 1.1
 ##
@@ -1247,7 +1247,7 @@
 #
 # @pid: pid returned from guest-exec
 #
-# Returns: GuestExecStatus on success.
+# Returns: GuestExecStatus
 #
 # Since: 2.5
 ##
@@ -1315,7 +1315,7 @@
 # @capture-output: bool flag to enable capture of stdout/stderr of
 #     running process.  defaults to false.
 #
-# Returns: PID on success.
+# Returns: PID
 #
 # Since: 2.5
 ##
@@ -1344,7 +1344,7 @@
 # or even present in DNS or some other name service at all.  It need
 # not even be unique on your local network or site, but usually it is.
 #
-# Returns: the host name of the machine on success
+# Returns: the host name of the machine
 #
 # Since: 2.10
 ##
-- 
2.43.0



  parent reply	other threads:[~2024-02-27 11:40 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 ` [PATCH 06/13] qapi: Clean up " Markus Armbruster
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 ` Markus Armbruster [this message]
2024-03-04  8:24   ` [PATCH 10/13] qga/qapi-schema: Clean up " 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-11-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).