Re: [PATCH 5/6] qapi: convert intro sections with "TODO" markers

[Markus Armbruster <armbru@redhat.com>]

John Snow <jsnow@redhat.com> writes:

> This patch converts intro sections that are immediately followed by a
> "TODO:" that was formerly used to demarcate the stub member insertion
> point.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  qapi/machine.json   |  7 ++-----
>  qapi/migration.json | 10 ++--------
>  qapi/net.json       |  9 +++------
>  qapi/yank.json      |  5 +----
>  4 files changed, 8 insertions(+), 23 deletions(-)
>
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 13875fc4642..108033b6d64 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -1216,11 +1216,8 @@
>  
>  ##
>  # @query-memory-size-summary:
> -#
> -# Return the amount of initially allocated and present hotpluggable
> -# (if enabled) memory in bytes.
> -#
> -# TODO: This line is a hack to separate the example from the body
> +#     Return the amount of initially allocated and present
> +#     hotpluggable (if enabled) memory in bytes.
>  #
>  # .. qmp-example::
>  #

I see output change from

    Command query-memory-size-summary (Since: 2.11)

       Return the amount of initially allocated and present hotpluggable
       (if enabled) memory in bytes.

       Return:
          "MemoryInfo"

       Example::

          -> { "execute": "query-memory-size-summary" }
          <- { "return": { "base-memory": 4294967296, "plugged-memory": 0 } }

to

    Command query-memory-size-summary (Since: 2.11)

       Return the amount of initially allocated and present hotpluggable
       (if enabled) memory in bytes.

       Example::

          -> { "execute": "query-memory-size-summary" }
          <- { "return": { "base-memory": 4294967296, "plugged-memory": 0 } }

       Return:
          "MemoryInfo"

Similar for the other hunks.  Surprising.  What's going on?

[...]