diff options
| author | Markus Armbruster <armbru@redhat.com> | 2025-04-04 14:14:13 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-04-08 09:04:34 +0200 |
| commit | 8d41a7dfc2a8f21228b7f29314dd68ad0aa96d10 (patch) | |
| tree | af61a2276233868808638430c5e08063082e7fdd | |
| parent | 5e03548bf222b0f8038dc61dbf0c93bd062025aa (diff) | |
| download | focaccia-qemu-8d41a7dfc2a8f21228b7f29314dd68ad0aa96d10.tar.gz focaccia-qemu-8d41a7dfc2a8f21228b7f29314dd68ad0aa96d10.zip | |
qga/qapi-schema: Add a proper introduction
Contents adapted from qapi/qapi-schema.json. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20250404121413.1743790-12-armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com>
| -rw-r--r-- | qga/qapi-schema.json | 20 |
1 files changed, 17 insertions, 3 deletions
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json index 35ec0e7db3..5316bfacbf 100644 --- a/qga/qapi-schema.json +++ b/qga/qapi-schema.json @@ -2,10 +2,24 @@ # vim: filetype=python ## -# = QEMU guest agent protocol commands and structs +# This manual describes the commands supported by the QEMU Guest +# Agent Protocol. # -# For a concise listing of all commands, events, and types in the QEMU -# guest agent, please consult the `qapi-qga-index`. +# For locating a particular item, please see the `qapi-qga-index`. +# +# The following notation is used in examples: +# +# .. qmp-example:: +# +# -> ... text sent by client (commands) ... +# <- ... text sent by server (command responses and events) ... +# +# Example text is formatted for readability. However, in real +# protocol usage, its commonly emitted as a single line. +# +# Please refer to the +# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>` +# for the general format of commands, responses, and events. ## { 'pragma': { 'doc-required': true } } |