qapi: Require member documentation (with loophole)

[PATCH 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks

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 | 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 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks

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 | 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 07/15] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks

Posted by Daniel P. Berrangé 9 months, 3 weeks ago

On Mon, Feb 05, 2024 at 08:47:01AM +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 | 19 ++++++++++---------
>  1 file changed, 10 insertions(+), 9 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 :|