[PATCH 6/7] qga/qapi-schema: Drop "Returns" section where default is fine WIP

Markus Armbruster posted 7 patches 6 months, 3 weeks ago
Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, Peter Maydell <peter.maydell@linaro.org>, Eric Blake <eblake@redhat.com>, Gerd Hoffmann <kraxel@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Gonglei (Arei)" <arei.gonglei@huawei.com>, Zhenwei Pi <pizhenwei@bytedance.com>, John Snow <jsnow@redhat.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Yanan Wang <wangyanan55@huawei.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, Pavel Dovgalyuk <pavel.dovgaluk@ispras.ru>, Jiri Pirko <jiri@resnulli.us>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Stefan Hajnoczi <stefanha@redhat.com>, Mads Ynddal <mads@ynddal.dk>, Lukas Straub <lukasstraub2@web.de>, Konstantin Kostiuk <kkostiuk@redhat.com>
[PATCH 6/7] qga/qapi-schema: Drop "Returns" section where default is fine WIP
Posted by Markus Armbruster 6 months, 3 weeks ago
---
 qga/qapi-schema.json | 40 +++++-----------------------------------
 1 file changed, 5 insertions(+), 35 deletions(-)

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index d5af155007..fe41670ed2 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -194,8 +194,6 @@
 #
 # Get some information about the guest agent.
 #
-# Returns: @GuestAgentInfo
-#
 # Since: 0.15.0
 ##
 { 'command': 'guest-info',
@@ -277,8 +275,6 @@
 # @count: maximum number of bytes to read (default is 4KB, maximum is
 #     48MB)
 #
-# Returns: @GuestFileRead
-#
 # Since: 0.15.0
 ##
 { 'command': 'guest-file-read',
@@ -312,8 +308,6 @@
 # @count: bytes to write (actual bytes, after base64-decode), default
 #     is all content in buf-b64 buffer after base64 decoding
 #
-# Returns: @GuestFileWrite
-#
 # Since: 0.15.0
 ##
 { 'command': 'guest-file-write',
@@ -379,8 +373,6 @@
 #
 # @whence: Symbolic or numeric code for interpreting offset
 #
-# Returns: @GuestFileSeek
-#
 # Since: 0.15.0
 ##
 { 'command': 'guest-file-seek',
@@ -419,9 +411,6 @@
 #
 # Get guest fsfreeze state.
 #
-# Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined
-#     below)
-#
 # Note: This may fail to properly report the current state as a result
 #     of some other guest processes having issued an fs freeze/thaw.
 #
@@ -725,8 +714,6 @@
 #
 # Get list of guest IP addresses, MAC addresses and netmasks.
 #
-# Returns: List of GuestNetworkInterface
-#
 # Since: 1.1
 ##
 { 'command': 'guest-network-get-interfaces',
@@ -760,6 +747,7 @@
 #
 # Returns: The list of all VCPUs the guest knows about.  Each VCPU is
 #     put on the list exactly once, but their order is unspecified.
+#     TODO
 #
 # Since: 1.5
 ##
@@ -1009,6 +997,7 @@
 #     the physical disks.  On Linux these are all root block devices
 #     of non-zero size including e.g. removable devices, loop devices,
 #     NBD, etc.
+#     TODO
 #
 # Since: 5.2
 ##
@@ -1045,6 +1034,7 @@
 #     The returned mountpoints may be specified to
 #     @guest-fsfreeze-freeze-list.  Network filesystems (such as CIFS
 #     and NFS) are not listed.
+#     TODO
 #
 # Since: 2.2
 ##
@@ -1108,6 +1098,7 @@
 # Returns: The list of all memory blocks the guest knows about.  Each
 #     memory block is put on the list exactly once, but their order is
 #     unspecified.
+#     TODO
 #
 # Since: 2.3
 ##
@@ -1179,6 +1170,7 @@
 #     Note: it will return an empty list if the @mem-blks list was
 #     empty on input, or there is an error, and in this case, guest
 #     state will not be changed.
+#     TODO
 #
 # Since: 2.3
 ##
@@ -1203,8 +1195,6 @@
 #
 # Get information relating to guest memory blocks.
 #
-# Returns: @GuestMemoryBlockInfo
-#
 # Since: 2.3
 ##
 { 'command': 'guest-get-memory-block-info',
@@ -1249,8 +1239,6 @@
 #
 # @pid: pid returned from guest-exec
 #
-# Returns: GuestExecStatus
-#
 # Since: 2.5
 ##
 { 'command': 'guest-exec-status',
@@ -1322,8 +1310,6 @@
 # @capture-output: bool flag to enable capture of stdout/stderr of
 #     running process.  Defaults to false.
 #
-# Returns: PID
-#
 # Since: 2.5
 ##
 { 'command': 'guest-exec',
@@ -1351,8 +1337,6 @@
 # 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
-#
 # Since: 2.10
 ##
 { 'command': 'guest-get-host-name',
@@ -1381,8 +1365,6 @@
 #
 # Retrieves a list of currently active users on the VM.
 #
-# Returns: A unique list of users.
-#
 # Since: 2.10
 ##
 { 'command': 'guest-get-users',
@@ -1407,8 +1389,6 @@
 #
 # Retrieves the timezone information from the guest.
 #
-# Returns: A GuestTimezone dictionary.
-#
 # Since: 2.10
 ##
 { 'command': 'guest-get-timezone',
@@ -1483,8 +1463,6 @@
 #
 # Retrieve guest operating system information
 #
-# Returns: @GuestOSInfo
-#
 # Since: 2.10
 ##
 { 'command': 'guest-get-osinfo',
@@ -1550,8 +1528,6 @@
 #
 # Retrieve information about device drivers in Windows guest
 #
-# Returns: @GuestDeviceInfo
-#
 # Since: 5.2
 ##
 { 'command': 'guest-get-devices',
@@ -1579,8 +1555,6 @@
 #
 # @username: the user account to add the authorized keys
 #
-# Returns: @GuestAuthorizedKeys
-#
 # Since: 5.2
 ##
 { 'command': 'guest-ssh-get-authorized-keys',
@@ -1707,8 +1681,6 @@
 #
 # Retrieve information about disk stats.
 #
-# Returns: List of disk stats of guest.
-#
 # Since: 7.1
 ##
 { 'command': 'guest-get-diskstats',
@@ -1791,8 +1763,6 @@
 #
 # Retrieve information about CPU stats.
 #
-# Returns: List of CPU stats of guest.
-#
 # Since: 7.1
 ##
 { 'command': 'guest-get-cpustats',
-- 
2.44.0
Re: [PATCH 6/7] qga/qapi-schema: Drop "Returns" section where default is fine WIP
Posted by Markus Armbruster 6 months, 3 weeks ago
Sent by accident, please ignore.