[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memor
From: |
Markus Armbruster |
Subject: |
[PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks |
Date: |
Mon, 5 Feb 2024 08:47:01 +0100 |
The command's doc comment describes the argument, but it's not marked
up as such. Easy enough to fix.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qga/qapi-schema.json | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index b9501c8c81..35bde36a1f 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -43,7 +43,6 @@
'GuestDiskSmart',
'GuestDiskStatsInfo',
'GuestNVMeSmart',
- 'guest-set-memory-blocks',
'guest-set-vcpus' ] } }
##
@@ -1174,14 +1173,16 @@
# Attempt to reconfigure (currently: enable/disable) state of memory
# blocks inside the guest.
#
-# The input list is processed node by node in order. In each node
-# @phys-index is used to look up the guest MEMORY BLOCK, for which
-# @online specifies the requested state. The set of distinct
-# @phys-index's is only required to be a subset of the guest-supported
-# identifiers. There's no restriction on list length or on repeating
-# the same @phys-index (with possibly different @online field).
-# Preferably the input list should describe a modified subset of
-# @guest-get-memory-blocks' return value.
+# @mem-blks: The memory blocks to be reconfigured. This list is
+# processed node by node in order. In each node @phys-index is
+# used to look up the guest MEMORY BLOCK, for which @online
+# specifies the requested state. The set of distinct
+# @phys-index's is only required to be a subset of the
+# guest-supported identifiers. There's no restriction on list
+# length or on repeating the same @phys-index (with possibly
+# different @online field). Preferably the input list should
+# describe a modified subset of @guest-get-memory-blocks' return
+# value.
#
# Returns: The operation results, it is a list of
# @GuestMemoryBlockResponse, which is corresponding to the input
--
2.43.0
- Re: [PATCH 11/15] qapi/dump: Clean up documentation of DumpGuestMemoryCapability, (continued)
- [PATCH 06/15] qapi: Require member documentation (with loophole), Markus Armbruster, 2024/02/05
- [PATCH 10/15] qapi/yank: Clean up documentaion of yank, Markus Armbruster, 2024/02/05
- [PATCH 14/15] qapi: Move @String out of common.json to discourage reuse, Markus Armbruster, 2024/02/05
- [PATCH 12/15] qapi: Plug trivial documentation holes around former simple unions, Markus Armbruster, 2024/02/05
- [PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks,
Markus Armbruster <=
- [PATCH 05/15] sphinx/qapidoc: Drop code to generate doc for simple union tag, Markus Armbruster, 2024/02/05
- [PATCH 13/15] qapi: Improve documentation of file descriptor socket addresses, Markus Armbruster, 2024/02/05
- [PATCH 01/15] docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y, Markus Armbruster, 2024/02/05
- [PATCH 09/15] qga/qapi-schema: Plug trivial documentation holes, Markus Armbruster, 2024/02/05