All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: "Thomas Weißschuh" <thomas.weissschuh@linutronix.de>
Cc: "Philippe Mathieu-Daudé" <philmd@linaro.org>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	"Kashyap Chamarthy" <kchamart@redhat.com>,
	qemu-devel@nongnu.org, "Kevin Wolf" <kwolf@redhat.com>,
	"Hanna Czenczek" <hreitz@redhat.com>
Subject: Re: [PATCH v5 3/4] docs/interop/firmware.json: convert "Example" section
Date: Thu, 18 Jul 2024 15:19:13 +0200	[thread overview]
Message-ID: <87wmlin8ha.fsf@pond.sub.org> (raw)
In-Reply-To: <20240718-qapi-firmware-json-v5-3-0dba12d7aaf5@linutronix.de> ("Thomas Weißschuh"'s message of "Thu, 18 Jul 2024 14:21:47 +0200")

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>



  parent reply	other threads:[~2024-07-18 13:20 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-18 12:21 [PATCH v5 0/4] docs/interop/firmware.json: scripts/qapi-gen.py compatibility Thomas Weißschuh
2024-07-18 12:21 ` [PATCH v5 1/4] docs/interop/firmware.json: add new enum FirmwareFormat Thomas Weißschuh
2024-07-18 13:09   ` Markus Armbruster
2024-07-18 13:25     ` Thomas Weißschuh
2024-07-18 13:46       ` Markus Armbruster
2024-07-18 14:02     ` Kashyap Chamarthy
2024-07-18 12:21 ` [PATCH v5 2/4] docs/interop/firmware.json: add new enum FirmwareArchitecture Thomas Weißschuh
2024-07-18 13:18   ` Markus Armbruster
2024-07-18 13:29     ` Thomas Weißschuh
2024-07-18 13:48       ` Markus Armbruster
2024-07-18 12:21 ` [PATCH v5 3/4] docs/interop/firmware.json: convert "Example" section Thomas Weißschuh
2024-07-18 12:30   ` Daniel P. Berrangé
2024-07-18 13:19   ` Markus Armbruster [this message]
2024-07-18 12:21 ` [PATCH v5 4/4] docs: add test for firmware.json QAPI Thomas Weißschuh

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87wmlin8ha.fsf@pond.sub.org \
    --to=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=hreitz@redhat.com \
    --cc=kchamart@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=philmd@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=thomas.weissschuh@linutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.