| Message ID | 20240205074709.3613229-9-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qapi: Require member documentation (with loophole) | expand |
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
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 > >
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.
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(-)