[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus
From: |
Markus Armbruster |
Subject: |
[PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus |
Date: |
Mon, 5 Feb 2024 08:47:02 +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 | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 35bde36a1f..f3d168d542 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -42,8 +42,7 @@
'GuestDeviceType',
'GuestDiskSmart',
'GuestDiskStatsInfo',
- 'GuestNVMeSmart',
- 'guest-set-vcpus' ] } }
+ 'GuestNVMeSmart' ] } }
##
# @guest-sync-delimited:
@@ -786,14 +785,15 @@
# Attempt to reconfigure (currently: enable/disable) logical
# processors inside the guest.
#
-# The input list is processed node by node in order. In each node
-# @logical-id is used to look up the guest VCPU, for which @online
-# specifies the requested state. The set of distinct @logical-id'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
-# @logical-id (with possibly different @online field). Preferably the
-# input list should describe a modified subset of @guest-get-vcpus'
-# return value.
+# @vcpus: The logical processors to be reconfigured. This list is
+# processed node by node in order. In each node @logical-id is
+# used to look up the guest VCPU, for which @online specifies the
+# requested state. The set of distinct @logical-id'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
+# @logical-id (with possibly different @online field). Preferably
+# the input list should describe a modified subset of
+# @guest-get-vcpus' return value.
#
# Returns: The length of the initial sublist that has been
# successfully processed. The guest agent maximizes this value.
--
2.43.0
- [PATCH 03/15] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup, (continued)
- [PATCH 03/15] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup, Markus Armbruster, 2024/02/05
- [PATCH 15/15] qapi: Add missing union tag documentation, Markus Armbruster, 2024/02/05
- [PATCH 04/15] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/02/05
- [PATCH 11/15] qapi/dump: Clean up documentation of DumpGuestMemoryCapability, Markus Armbruster, 2024/02/05
- [PATCH 10/15] qapi/yank: Clean up documentaion of yank, Markus Armbruster, 2024/02/05
- [PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus,
Markus Armbruster <=
- [PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks, Markus Armbruster, 2024/02/05
- Re: [PATCH 00/15] qapi: Require member documentation (with loophole), Peter Xu, 2024/02/06