[PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus

Markus Armbruster posted 15 patches 9 months, 3 weeks ago
Maintainers: "Marc-André Lureau" <marcandre.lureau@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, Peter Maydell <peter.maydell@linaro.org>, "Michael S. Tsirkin" <mst@redhat.com>, Jason Wang <jasowang@redhat.com>, Eric Blake <eblake@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, 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>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Gerd Hoffmann <kraxel@redhat.com>, Lukas Straub <lukasstraub2@web.de>, Konstantin Kostiuk <kkostiuk@redhat.com>
[PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus
Posted by Markus Armbruster 9 months, 3 weeks ago
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
Re: [PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus
Posted by Konstantin Kostiuk 9 months, 1 week ago
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>

On Mon, Feb 5, 2024 at 9:47 AM Markus Armbruster <armbru@redhat.com> wrote:

> 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
>
>
Re: [PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus
Posted by Daniel P. Berrangé 9 months, 3 weeks ago
On Mon, Feb 05, 2024 at 08:47:02AM +0100, Markus Armbruster wrote:
> 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(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|