[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v5 3/4] docs/interop/firmware.json: convert "Example" section
From: |
Markus Armbruster |
Subject: |
Re: [PATCH v5 3/4] docs/interop/firmware.json: convert "Example" section |
Date: |
Thu, 18 Jul 2024 15:19:13 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) |
Thomas Weißschuh <thomas.weissschuh@linutronix.de> writes:
> Since commit 3c5f6114d9ff ("qapi: remove "Example" doc section")
> the "Example" section is not valid anymore.
> It has been replaced by the "qmp-example" role.
Make that "directive" instead of role.
> This was not detected earlier as firmware.json was not validated.
Sorry about that!
> As this validation is about to be added, adapt firmware.json.
>
> Signed-off-by: Thomas Weißschuh <thomas.weissschuh@linutronix.de>
> ---
> docs/interop/firmware.json | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
> index 2eb0be11d595..eea82eef3a07 100644
> --- a/docs/interop/firmware.json
> +++ b/docs/interop/firmware.json
> @@ -471,7 +471,7 @@
> #
> # Since: 3.0
> #
> -# Examples:
> +# .. qmp-example::
> #
> # {
> # "description": "SeaBIOS",
Reviewed-by: Markus Armbruster <armbru@redhat.com>