Re: [PATCH 09/11] qapi/qapi-schema: Address the introduction's bit rot

[John Snow <jsnow@redhat.com>]

[-- Attachment #1: Type: text/plain, Size: 2283 bytes --]

On Fri, Apr 4, 2025 at 8:14 AM Markus Armbruster <armbru@redhat.com> wrote:

> Cut the crap that stopped making sense years ago.  Adjust the
> remainder.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/qapi-schema.json | 27 +++++++--------------------
>  1 file changed, 7 insertions(+), 20 deletions(-)
>
> diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json
> index 0d027d5017..7bc600bb76 100644
> --- a/qapi/qapi-schema.json
> +++ b/qapi/qapi-schema.json
> @@ -3,37 +3,24 @@
>  ##
>  # = Introduction
>  #
> -# This document describes all commands currently supported by QMP.
> +# This manual describes the commands and events supported by the QEMU
> +# Monitor Protocol (QMP).
>  #
>  # For locating a particular item, please see the `qapi-qmp-index`.
>  #
> -# Most of the time their usage is exactly the same as in the user
> -# Monitor, this means that any other document which also describe
> -# commands (the manpage, QEMU's manual, etc) can and should be
> -# consulted.
> -#
> -# QMP has two types of commands: regular and query commands.  Regular
> -# commands usually change the Virtual Machine's state someway, while
> -# query commands just return information.  The sections below are
> -# divided accordingly.
> -#
> -# It's important to observe that all communication examples are
> -# formatted in a reader-friendly way, so that they're easier to
> -# understand.  However, in real protocol usage, they're emitted as a
> -# single line.
> -#
> -# Also, the following notation is used to denote data flow:
> -#
> -# Example:
> +# The following notation is used in examples:
>  #
>  # .. qmp-example::
>  #
>  #   -> ... text sent by client (commands) ...
>  #   <- ... text sent by server (command responses and events) ...
>  #
> +# Example text is formatted for readability.  However, in real
> +# protocol usage, its commonly emitted as a single line.
> +#
>  # Please refer to the
>  # :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
> -# for detailed information on the Server command and response formats.
> +# for the general format of commands, responses, and events.
>  ##
>
>  { 'include': 'pragma.json' }
> --
> 2.48.1


Thanks for this one :)

[-- Attachment #2: Type: text/html, Size: 2884 bytes --]