qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v6 01/21] qapi: Fix doc comment indentation again


From: Markus Armbruster
Subject: Re: [PATCH v6 01/21] qapi: Fix doc comment indentation again
Date: Mon, 28 Sep 2020 14:39:07 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux)

Peter Maydell <peter.maydell@linaro.org> writes:

> In commit 26ec4e53f2 and similar commits we fixed the indentation
> for doc comments in our qapi json files to follow a new stricter
> standard for indentation, which permits only:
>     @arg: description line 1
>           description line 2
>
> or:
>     @arg:
>     line 1
>     line 2
>
> but because the script updates that enforce this are not yet in the
> tree we have had a steady trickle of subsequent changes which didn't
> follow the new rules.
>
> Fix the latest round of mis-indented doc comments.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  qapi/block-core.json |   4 +-
>  qapi/migration.json  | 102 +++++++++++++++++++++----------------------
>  2 files changed, 53 insertions(+), 53 deletions(-)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 3c16f1e11d6..dd77a91174c 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -4316,8 +4316,8 @@
>  # @data-file-raw: True if the external data file must stay valid as a
>  #                 standalone (read-only) raw image without looking at qcow2
>  #                 metadata (default: false; since: 4.0)
> -# @extended-l2      True to make the image have extended L2 entries
> -#                   (default: false; since 5.2)
> +# @extended-l2: True to make the image have extended L2 entries
> +#               (default: false; since 5.2)
>  # @size: Size of the virtual disk in bytes
>  # @version: Compatibility level (default: v3)
>  # @backing-file: File name of the backing file if a backing file

Fixes a missing colon in addition to indentation.

[...]

Reviewed-by: Markus Armbruster <armbru@redhat.com>




reply via email to

[Prev in Thread] Current Thread [Next in Thread]