motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-04 08:13:54 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/devel/qapi-code-gen: Improve the part on qmp-example directive

Browse source 
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250404121413.1743790-6-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Markus Armbruster 2025-04-04 14:14:07 +02:00
parent 0d4c7ea0f8
commit e27608d053
1 changed files with 14 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/devel/qapi-code-gen.rst
View file

@ -1038,20 +1038,15 @@ default to "Example:".
A simple QMP example::
# .. qmp-example::
# :title: Using query-block
#
# -> { "execute": "query-block" }
# <- { ... }
# -> { "execute": "query-name" }
# <- { "return": { "name": "Fred" } }
More complex or multi-step examples where exposition is needed before
or between QMP code blocks can be created by using the ``:annotated:``
directive option. When using this option, nested QMP code blocks must
be entered explicitly with rST's ``::`` syntax.
Highlighting in non-QMP languages can be accomplished by using the
``.. code-block:: lang`` directive, and non-highlighted text can be
achieved by omitting the language argument.
For example::
# .. qmp-example::
@ -1061,11 +1056,21 @@ For example::
# This is a more complex example that can use
# ``arbitrary rST syntax`` in its exposition::
#
# -> { "execute": "query-block" }
# <- { ... }
# -> { "execute": "query-block" }
# <- { "return": [
# {
# "device": "ide0-hd0",
# ...
# }
# ...
# ] }
#
# Above, lengthy output has been omitted for brevity.
Highlighting in non-QMP languages can be accomplished by using the
``.. code-block:: lang`` directive, and non-highlighted text can be
achieved by omitting the language argument.
Examples of complete definition documentation::