diff mbox

[v6,03/17] qga/schema: improve guest-set-vcpus Returns: section

Message ID 20161206141343.28044-4-marcandre.lureau@redhat.com
State New
Headers show

Commit Message

Marc-André Lureau Dec. 6, 2016, 2:13 p.m. UTC
Itemize the possible return values of guest-set-vcpus.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
 qga/qapi-schema.json | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Markus Armbruster Dec. 21, 2016, 10:13 a.m. UTC | #1
Marc-André Lureau <marcandre.lureau@redhat.com> writes:

> Itemize the possible return values of guest-set-vcpus.
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
>  qga/qapi-schema.json | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 94c03128fd..ad63737fce 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -697,21 +697,21 @@
>  # Returns: The length of the initial sublist that has been successfully
>  #          processed. The guest agent maximizes this value. Possible cases:
>  #
> -#          0:                if the @vcpus list was empty on input. Guest state
> +#          - 0:              if the @vcpus list was empty on input. Guest state
>  #                            has not been changed. Otherwise,
>  #
> -#          Error:            processing the first node of @vcpus failed for the
> +#          - Error:          processing the first node of @vcpus failed for the
>  #                            reason returned. Guest state has not been changed.
>  #                            Otherwise,
>  #
> -#          < length(@vcpus): more than zero initial nodes have been processed,
> +#          - < length(@vcpus): more than zero initial nodes have been processed,
>  #                            but not the entire @vcpus list. Guest state has
>  #                            changed accordingly. To retrieve the error
>  #                            (assuming it persists), repeat the call with the
>  #                            successfully processed initial sublist removed.
>  #                            Otherwise,
>  #
> -#          length(@vcpus):   call successful.
> +#          - length(@vcpus): call successful.
>  #
>  # Since: 1.5
>  ##

I'm fine with this as is, therefore
Reviewed-by: Markus Armbruster <armbru@redhat.com>

But do feel free to drop the blank lines for consistency with itemized
lists elsewhere.
diff mbox

Patch

diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 94c03128fd..ad63737fce 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -697,21 +697,21 @@ 
 # Returns: The length of the initial sublist that has been successfully
 #          processed. The guest agent maximizes this value. Possible cases:
 #
-#          0:                if the @vcpus list was empty on input. Guest state
+#          - 0:              if the @vcpus list was empty on input. Guest state
 #                            has not been changed. Otherwise,
 #
-#          Error:            processing the first node of @vcpus failed for the
+#          - Error:          processing the first node of @vcpus failed for the
 #                            reason returned. Guest state has not been changed.
 #                            Otherwise,
 #
-#          < length(@vcpus): more than zero initial nodes have been processed,
+#          - < length(@vcpus): more than zero initial nodes have been processed,
 #                            but not the entire @vcpus list. Guest state has
 #                            changed accordingly. To retrieve the error
 #                            (assuming it persists), repeat the call with the
 #                            successfully processed initial sublist removed.
 #                            Otherwise,
 #
-#          length(@vcpus):   call successful.
+#          - length(@vcpus): call successful.
 #
 # Since: 1.5
 ##