Skip to content

Commit 9199d32

Browse files
author
Markus Armbruster
committed
qapi/qapi-schema: Address the introduction's bit rot
Cut the crap that stopped making sense years ago. Adjust the remainder. Signed-off-by: Markus Armbruster <[email protected]> Message-ID: <[email protected]> Reviewed-by: Eric Blake <[email protected]>
1 parent d0ae5a3 commit 9199d32

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

qapi/qapi-schema.json

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,24 @@
33
##
44
# = Introduction
55
#
6-
# This document describes all commands currently supported by QMP.
6+
# This manual describes the commands and events supported by the QEMU
7+
# Monitor Protocol (QMP).
78
#
89
# For locating a particular item, please see the `qapi-qmp-index`.
910
#
10-
# Most of the time their usage is exactly the same as in the user
11-
# Monitor, this means that any other document which also describe
12-
# commands (the manpage, QEMU's manual, etc) can and should be
13-
# consulted.
14-
#
15-
# QMP has two types of commands: regular and query commands. Regular
16-
# commands usually change the Virtual Machine's state someway, while
17-
# query commands just return information. The sections below are
18-
# divided accordingly.
19-
#
20-
# It's important to observe that all communication examples are
21-
# formatted in a reader-friendly way, so that they're easier to
22-
# understand. However, in real protocol usage, they're emitted as a
23-
# single line.
24-
#
25-
# Also, the following notation is used to denote data flow:
26-
#
27-
# Example:
11+
# The following notation is used in examples:
2812
#
2913
# .. qmp-example::
3014
#
3115
# -> ... text sent by client (commands) ...
3216
# <- ... text sent by server (command responses and events) ...
3317
#
18+
# Example text is formatted for readability. However, in real
19+
# protocol usage, its commonly emitted as a single line.
20+
#
3421
# Please refer to the
3522
# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
36-
# for detailed information on the Server command and response formats.
23+
# for the general format of commands, responses, and events.
3724
##
3825

3926
{ 'include': 'pragma.json' }

0 commit comments

Comments
 (0)