[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH v3 03/14] qga/schema: improve guest-set-vcpus Re
From: |
Markus Armbruster |
Subject: |
Re: [Qemu-devel] [PATCH v3 03/14] qga/schema: improve guest-set-vcpus Returns: section |
Date: |
Mon, 07 Nov 2016 16:25:04 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux) |
Marc-André Lureau <address@hidden> writes:
> The documentation parser finishes a section after an empty line. Fix the
Suggest "The documentation parser we're going to add".
> Returns: section of guest-set-vcpus, and itemize the possible return
> values.
>
> Signed-off-by: Marc-André Lureau <address@hidden>
> ---
> qga/qapi-schema.json | 12 ++++--------
> 1 file changed, 4 insertions(+), 8 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 758803a..cb68c17 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -696,22 +696,18 @@
> #
> # 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
> ##
Matches how we format similar lists elswhere.
If the "empty line ends section" syntax turns out to be inconvenient, we
can try to consider indentation. But not now.
- [Qemu-devel] [PATCH v3 00/14] qapi doc generation (whole version, squashed), Marc-André Lureau, 2016/11/07
- [Qemu-devel] [PATCH v3 01/14] qapi: add missing 'bus' argument in device_add, Marc-André Lureau, 2016/11/07
- [Qemu-devel] [PATCH v3 02/14] qga/schema: fix double-return in doc, Marc-André Lureau, 2016/11/07
- [Qemu-devel] [PATCH v3 03/14] qga/schema: improve guest-set-vcpus Returns: section, Marc-André Lureau, 2016/11/07
- Re: [Qemu-devel] [PATCH v3 03/14] qga/schema: improve guest-set-vcpus Returns: section,
Markus Armbruster <=
- [Qemu-devel] [PATCH v3 05/14] qapi: fix missing symbol @prefix, Marc-André Lureau, 2016/11/07
- [Qemu-devel] [PATCH v3 04/14] qapi: fix schema symbol sections, Marc-André Lureau, 2016/11/07
- [Qemu-devel] [PATCH v3 06/14] qapi: fix various symbols mismatch in documentation, Marc-André Lureau, 2016/11/07
- [Qemu-devel] [PATCH v3 07/14] qapi: use one symbol per line, Marc-André Lureau, 2016/11/07
- [Qemu-devel] [PATCH v3 09/14] qapi: add some sections in docs, Marc-André Lureau, 2016/11/07