Re: [PATCH 4/9] qapi: convert simple intros for qga/qapi-schema.json

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> These are all single-paragraph introductions immediately followed by a
> non-plaintext section, so no new insertion point is created by this
> conversion.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  qga/qapi-schema.json | 40 ++++++++++++++++++----------------------
>  1 file changed, 18 insertions(+), 22 deletions(-)
>
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 90110af5730..b592b14a011 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -205,9 +205,9 @@
>  
>  ##
>  # @guest-shutdown:
> -#
> -# Initiate guest-activated shutdown.  Note: this is an asynchronous
> -# shutdown request, with no guarantee of successful shutdown.
> +#     Initiate guest-activated shutdown.  Note: this is an
> +#     asynchronous shutdown request, with no guarantee of successful
> +#     shutdown.

Taking note of future work:

10. Review doc where the intro contains (variations of) "Note:".

>  #
>  # @mode: "halt", "powerdown" (default), or "reboot"
>  #
> @@ -266,10 +266,10 @@
>  
>  ##
>  # @guest-file-read:
> -#
> -# Read from an open file in the guest.  Data will be base64-encoded.
> -# As this command is just for limited, ad-hoc debugging, such as log
> -# file access, the number of bytes to read is limited to 48 MB.
> +#     Read from an open file in the guest.  Data will be
> +#     base64-encoded.  As this command is just for limited, ad-hoc
> +#     debugging, such as log file access, the number of bytes to read
> +#     is limited to 48 MB.
>  #
>  # @handle: filehandle returned by `guest-file-open`
>  #
> @@ -357,10 +357,9 @@
>  
>  ##
>  # @guest-file-seek:
> -#
> -# Seek to a position in the file, as with fseek(), and return the
> -# current file position afterward.  Also encapsulates ftell()'s
> -# functionality, with offset=0 and whence=1.
> +#     Seek to a position in the file, as with fseek(), and return the
> +#     current file position afterward.  Also encapsulates ftell()'s
> +#     functionality, with offset=0 and whence=1.

Not this patch's problem, but here goes anyway: numeric @whence values
like 1 are "available for historical reasons", the preferred value is
"cur".

>  #
>  # @handle: filehandle returned by `guest-file-open`
>  #

[...]