diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2023-05-15 17:22:43 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-05-22 10:21:01 +0200 |
| commit | d56572584d9a5414c6a55c3f6b7ecce4b098926b (patch) | |
| tree | 95714599acc2811df158237c26efedfa9ef69395 /qapi | |
| parent | 290e48e8f1ec975c100520fb697b0ae7300d0fb3 (diff) | |
| download | qemu-d56572584d9a5414c6a55c3f6b7ecce4b098926b.zip qemu-d56572584d9a5414c6a55c3f6b7ecce4b098926b.tar.gz qemu-d56572584d9a5414c6a55c3f6b7ecce4b098926b.tar.bz2 | |
docs/interop: Convert qmp-spec.txt to rST
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]
Diffstat (limited to 'qapi')
| -rw-r--r-- | qapi/control.json | 4 | ||||
| -rw-r--r-- | qapi/qapi-schema.json | 3 |
2 files changed, 4 insertions, 3 deletions
diff --git a/qapi/control.json b/qapi/control.json index 6a7c5af..a91fa33 100644 --- a/qapi/control.json +++ b/qapi/control.json @@ -27,7 +27,7 @@ # Notes: This command is valid exactly when first connecting: it must # be issued before any other command will be accepted, and will # fail once the monitor is accepting other commands. (see qemu -# docs/interop/qmp-spec.txt) +# docs/interop/qmp-spec.rst) # # The QMP client needs to explicitly enable QMP capabilities, # otherwise all the QMP capabilities will be turned off by @@ -46,7 +46,7 @@ # connection, used for agreeing on particular QMP extension behaviors. # # @oob: QMP ability to support out-of-band requests. (Please refer to -# qmp-spec.txt for more information on OOB) +# qmp-spec.rst for more information on OOB) # # Since: 2.12 ## diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json index 31e0b36..6594afb 100644 --- a/qapi/qapi-schema.json +++ b/qapi/qapi-schema.json @@ -29,7 +29,8 @@ # -> data issued by the Client # <- Server data response # -# Please, refer to the QMP specification (docs/interop/qmp-spec.txt) +# Please refer to the +# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>` # for detailed information on the Server command and response formats. ## |