Re: [PATCH 5/8] qapi: convert "Example" sections without titles

[Markus Armbruster]

John Snow <jsnow@redhat.com> writes:

> Use the no-option form of ".. qmp-example::" to convert any Examples
> that do not have any form of caption or explanation whatsoever. Note
> that in a few cases, example sections are split into two or more
> separate example blocks. This is only done stylistically to create a
> delineation between two or more logically independent examples.
>
> See commit-3: "docs/qapidoc: create qmp-example directive", for a
>               detailed explanation of this custom directive syntax.
>
> See commit+3: "qapi: remove "Example" doc section" for a detailed
>               explanation of why.
>
> Signed-off-by: John Snow <jsnow@redhat.com>

[...]

> diff --git a/qapi/run-state.json b/qapi/run-state.json
> index 252d7d6afa7..718a3c958e9 100644
> --- a/qapi/run-state.json
> +++ b/qapi/run-state.json

[...]

> @@ -453,7 +453,7 @@
>  #
>  # Since: 5.0
>  #
> -# Example:
> +# .. qmp-example::
>  #
>  #     <- { "event": "GUEST_CRASHLOADED",
>  #          "data": { "action": "run" },

Trivial semantic conflict, we need

  @@ -469,7 +469,7 @@
   #
   # Since: 9.1
   #
  -# Example:
  +# .. qmp-example::
   #
   #     <- { "event": "GUEST_PVSHUTDOWN",
   #          "timestamp": { "seconds": 1648245259, "microseconds": 893771 } }


> @@ -597,7 +597,7 @@
>  #
>  # Since: 5.2
>  #
> -# Example:
> +# .. qmp-example::
>  #
>  #     <- { "event": "MEMORY_FAILURE",
>  #          "data": { "recipient": "hypervisor",

[...]