| Message ID | 20240718-qapi-firmware-json-v5-3-0dba12d7aaf5@linutronix.de |
|---|---|
| State | New |
| Headers | show |
| Series | docs/interop/firmware.json: scripts/qapi-gen.py compatibility | expand |
On Thu, Jul 18, 2024 at 02:21:47PM +0200, Thomas Weißschuh wrote: > Since commit 3c5f6114d9ff ("qapi: remove "Example" doc section") > the "Example" section is not valid anymore. > It has been replaced by the "qmp-example" role. > > This was not detected earlier as firmware.json was not validated. > 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(-) Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> With regards, Daniel
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>
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",
Since commit 3c5f6114d9ff ("qapi: remove "Example" doc section") the "Example" section is not valid anymore. It has been replaced by the "qmp-example" role. This was not detected earlier as firmware.json was not validated. 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(-)