Skip to content

Commit 8d41a7d

Browse files
author
Markus Armbruster
committed
qga/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 5e03548 commit 8d41a7d

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

qga/qapi-schema.json

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,24 @@
22
# vim: filetype=python
33

44
##
5-
# = QEMU guest agent protocol commands and structs
5+
# This manual describes the commands supported by the QEMU Guest
6+
# Agent Protocol.
67
#
7-
# For a concise listing of all commands, events, and types in the QEMU
8-
# guest agent, please consult the `qapi-qga-index`.
8+
# For locating a particular item, please see the `qapi-qga-index`.
9+
#
10+
# The following notation is used in examples:
11+
#
12+
# .. qmp-example::
13+
#
14+
# -> ... text sent by client (commands) ...
15+
# <- ... text sent by server (command responses and events) ...
16+
#
17+
# Example text is formatted for readability. However, in real
18+
# protocol usage, its commonly emitted as a single line.
19+
#
20+
# Please refer to the
21+
# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
22+
# for the general format of commands, responses, and events.
923
##
1024

1125
{ 'pragma': { 'doc-required': true } }

0 commit comments

Comments
 (0)