diff mbox series

[12/13] qga/qapi-schema: Fix guest-set-memory-blocks documentation

Message ID 20240227113921.236097-13-armbru@redhat.com (mailing list archive)
State New, archived
Headers show
Series Subject: [PATCH 00/15] qapi: Improve command response documentation | expand

Commit Message

Markus Armbruster Feb. 27, 2024, 11:39 a.m. UTC
Documentation claims the command can "return NULL".  "NULL" doesn't
exist in JSON.  "null" does, but the command returns lists, and null
isn't.  Correct documentation to "return an empty list".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qga/qapi-schema.json | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Konstantin Kostiuk March 4, 2024, 8:16 a.m. UTC | #1
Reviewed-by: Konstantin Kostiuk <kkostiuk@redhat.com>

On Tue, Feb 27, 2024 at 1:39 PM Markus Armbruster <armbru@redhat.com> wrote:

> Documentation claims the command can "return NULL".  "NULL" doesn't
> exist in JSON.  "null" does, but the command returns lists, and null
> isn't.  Correct documentation to "return an empty list".
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qga/qapi-schema.json | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 2ea1022092..9554b566a7 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -1176,9 +1176,9 @@
>  #     @GuestMemoryBlockResponse, which is corresponding to the input
>  #     list.
>  #
> -#     Note: it will return NULL if the @mem-blks list was empty on
> -#     input, or there is an error, and in this case, guest state will
> -#     not be changed.
> +#     Note: it will return an empty list if the @mem-blks list was
> +#     empty on input, or there is an error, and in this case, guest
> +#     state will not be changed.
>  #
>  # Since: 2.3
>  ##
> --
> 2.43.0
>
>
diff mbox series

Patch

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 2ea1022092..9554b566a7 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1176,9 +1176,9 @@ 
 #     @GuestMemoryBlockResponse, which is corresponding to the input
 #     list.
 #
-#     Note: it will return NULL if the @mem-blks list was empty on
-#     input, or there is an error, and in this case, guest state will
-#     not be changed.
+#     Note: it will return an empty list if the @mem-blks list was
+#     empty on input, or there is an error, and in this case, guest
+#     state will not be changed.
 #
 # Since: 2.3
 ##