qga/qapi-schema: Clean up documentation of guest-set-vcpus

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>
Message-ID: <20240205074709.3613229-9-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-05 08:47:02 +01:00
parent ab27bb03d3
commit 0b34cf84e6

View File

@ -42,8 +42,7 @@
'GuestDeviceType', 'GuestDeviceType',
'GuestDiskSmart', 'GuestDiskSmart',
'GuestDiskStatsInfo', 'GuestDiskStatsInfo',
'GuestNVMeSmart', 'GuestNVMeSmart' ] } }
'guest-set-vcpus' ] } }
## ##
# @guest-sync-delimited: # @guest-sync-delimited:
@ -786,14 +785,15 @@
# Attempt to reconfigure (currently: enable/disable) logical # Attempt to reconfigure (currently: enable/disable) logical
# processors inside the guest. # processors inside the guest.
# #
# The input list is processed node by node in order. In each node # @vcpus: The logical processors to be reconfigured. This list is
# @logical-id is used to look up the guest VCPU, for which @online # processed node by node in order. In each node @logical-id is
# specifies the requested state. The set of distinct @logical-id's is # used to look up the guest VCPU, for which @online specifies the
# only required to be a subset of the guest-supported identifiers. # 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 # There's no restriction on list length or on repeating the same
# @logical-id (with possibly different @online field). Preferably the # @logical-id (with possibly different @online field). Preferably
# input list should describe a modified subset of @guest-get-vcpus' # the input list should describe a modified subset of
# return value. # @guest-get-vcpus' return value.
# #
# Returns: The length of the initial sublist that has been # Returns: The length of the initial sublist that has been
# successfully processed. The guest agent maximizes this value. # successfully processed. The guest agent maximizes this value.