Skip to content

Commit

Permalink
docs/interop: Convert qmp-spec.txt to rST
Browse files Browse the repository at this point in the history
Convert the qmp-spec.txt document to restructuredText.
Notable points about the conversion:
 * numbers at the start of section headings are removed, to match
   the style of the rest of the manual
 * cross-references to other sections or documents are hyperlinked
 * various formatting tweaks (notably the examples, which need the
   -> and <- prefixed so the QMP code-block lexer will accept them)
 * English prose fixed in a few places

Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20230515162245.3964307-2-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
[.. code-block:: dumbed down to :: to work around CI failure]
  • Loading branch information
pm215 authored and Markus Armbruster committed May 22, 2023
1 parent 290e48e commit d565725
Show file tree
Hide file tree
Showing 8 changed files with 197 additions and 161 deletions.
3 changes: 2 additions & 1 deletion docs/devel/qapi-code-gen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,8 @@ Member 'allow-oob' declares whether the command supports out-of-band
{ 'command': 'migrate_recover',
'data': { 'uri': 'str' }, 'allow-oob': true }

See qmp-spec.txt for out-of-band execution syntax and semantics.
See the :doc:`/interop/qmp-spec` for out-of-band execution syntax
and semantics.

Commands supporting out-of-band execution can still be executed
in-band.
Expand Down
1 change: 1 addition & 0 deletions docs/interop/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ are useful for making QEMU interoperate with other software.
dbus-display
live-block-operations
pr-helper
qmp-spec
qemu-ga
qemu-ga-ref
qemu-qmp-ref
Expand Down

0 comments on commit d565725

Please sign in to comment.