qapi: convert "Example" sections without titles
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 <jsnow@redhat.com>
Message-ID: <20240717021312.606116-7-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Markup fixed in one place]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
committed by
Markus Armbruster
parent
e597a73a8c
commit
14b48aaab9
+4
-4
@@ -16,7 +16,7 @@
|
||||
# the QMP greeting message. If the field is not provided, it
|
||||
# means no QMP capabilities will be enabled. (since 2.12)
|
||||
#
|
||||
# Example:
|
||||
# .. qmp-example::
|
||||
#
|
||||
# -> { "execute": "qmp_capabilities",
|
||||
# "arguments": { "enable": [ "oob" ] } }
|
||||
@@ -97,7 +97,7 @@
|
||||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
# Example:
|
||||
# .. qmp-example::
|
||||
#
|
||||
# -> { "execute": "query-version" }
|
||||
# <- {
|
||||
@@ -134,7 +134,7 @@
|
||||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
# Example:
|
||||
# .. qmp-example::
|
||||
#
|
||||
# -> { "execute": "query-commands" }
|
||||
# <- {
|
||||
@@ -165,7 +165,7 @@
|
||||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
# Example:
|
||||
# .. qmp-example::
|
||||
#
|
||||
# -> { "execute": "quit" }
|
||||
# <- { "return": {} }
|
||||
|
||||
Reference in New Issue
Block a user