[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 10/18] qga/qapi-schema: Clean up "Returns" sections
From: |
Markus Armbruster |
Subject: |
[PULL 10/18] qga/qapi-schema: Clean up "Returns" sections |
Date: |
Mon, 4 Mar 2024 07:32:28 +0100 |
Drop "on success" where it is redundant with "Returns:".
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-11-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.44.0
- [PULL 00/18] QAPI patches patches for 2024-03-04, Markus Armbruster, 2024/03/04
- [PULL 01/18] qapi: Memorize since & returns sections, Markus Armbruster, 2024/03/04
- [PULL 02/18] qapi: Slightly clearer error message for invalid "Returns" section, Markus Armbruster, 2024/03/04
- [PULL 03/18] qapi: New documentation section tag "Errors", Markus Armbruster, 2024/03/04
- [PULL 09/18] qga/qapi-schema: Delete useless "Returns" sections, Markus Armbruster, 2024/03/04
- [PULL 12/18] qga/qapi-schema: Fix guest-set-memory-blocks documentation, Markus Armbruster, 2024/03/04
- [PULL 14/18] docs/devel/writing-monitor-commands: Repair a decade of rot, Markus Armbruster, 2024/03/04
- [PULL 17/18] qapi: New strv_from_str_list(), Markus Armbruster, 2024/03/04
- [PULL 10/18] qga/qapi-schema: Clean up "Returns" sections,
Markus Armbruster <=
- [PULL 08/18] qga/qapi-schema: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/03/04
- [PULL 16/18] qapi: New QAPI_LIST_LENGTH(), Markus Armbruster, 2024/03/04
- [PULL 05/18] qapi: Delete useless "Returns" sections, Markus Armbruster, 2024/03/04
- [PULL 11/18] qga/qapi-schema: Tweak documentation of fsfreeze commands, Markus Armbruster, 2024/03/04
- [PULL 07/18] qapi/yank: Tweak @yank's error description for consistency, Markus Armbruster, 2024/03/04
- [PULL 06/18] qapi: Clean up "Returns" sections, Markus Armbruster, 2024/03/04
- [PULL 15/18] docs/devel/writing-monitor-commands: Minor improvements, Markus Armbruster, 2024/03/04
- [PULL 13/18] qapi: Reject "Returns" section when command doesn't return anything, Markus Armbruster, 2024/03/04
- [PULL 04/18] qapi: Move error documentation to new "Errors" sections, Markus Armbruster, 2024/03/04
- [PULL 18/18] migration: simplify exec migration functions, Markus Armbruster, 2024/03/04