Skip to content

Commit 5e03548

Browse files
author
Markus Armbruster
committed
storage-daemon/qapi/qapi-schema: Add a proper introduction
Contents adapted from qapi/qapi-schema.json. Signed-off-by: Markus Armbruster <[email protected]> Message-ID: <[email protected]> Reviewed-by: Eric Blake <[email protected]>
1 parent 9199d32 commit 5e03548

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

storage-daemon/qapi/qapi-schema.json

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,26 @@
1414
# storage daemon.
1515

1616
##
17-
# = QEMU storage daemon protocol commands and structs
17+
# = Introduction
1818
#
19-
# For a concise listing of all commands, events, and types in the QEMU
20-
# storage daemon, please consult the `qapi-qsd-index`.
19+
# This manual describes the commands and events supported by the QEMU
20+
# storage daemon QMP.
21+
#
22+
# For locating a particular item, please see the `qapi-qsd-index`.
23+
#
24+
# The following notation is used in examples:
25+
#
26+
# .. qmp-example::
27+
#
28+
# -> ... text sent by client (commands) ...
29+
# <- ... text sent by server (command responses and events) ...
30+
#
31+
# Example text is formatted for readability. However, in real
32+
# protocol usage, its commonly emitted as a single line.
33+
#
34+
# Please refer to the
35+
# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
36+
# for the general format of commands, responses, and events.
2137
##
2238

2339

0 commit comments

Comments
 (0)