John Snow <js...@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. > > Note: an empty "TODO" line was added to announce-self to keep the > example from floating up into the body; this will be addressed more > rigorously in the new qapidoc generator. > > Signed-off-by: John Snow <js...@redhat.com>
[...] > diff --git a/qapi/run-state.json b/qapi/run-state.json > index 4d40c88876c..ab7116680b3 100644 > --- a/qapi/run-state.json > +++ b/qapi/run-state.json [...] > @@ -469,7 +469,7 @@ > # > # Since: 9.1 > # > -# Example: > +# ..qmp-example:: Lacks a space, output is messed up. Can fix in my tree. > # > # <- { "event": "GUEST_PVSHUTDOWN", > # "timestamp": { "seconds": 1648245259, "microseconds": 893771 } } [...] R-by stands.