diff options
| author | Markus Armbruster <armbru@redhat.com> | 2025-04-04 14:14:12 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-04-08 09:04:34 +0200 |
| commit | 5e03548bf222b0f8038dc61dbf0c93bd062025aa (patch) | |
| tree | 6b7511ceb31efa79267253314f6f7cf5a82e0026 | |
| parent | 9199d324a85cd3d4697b5907e804b903b5ce46e3 (diff) | |
| download | qemu-5e03548bf222b0f8038dc61dbf0c93bd062025aa.zip qemu-5e03548bf222b0f8038dc61dbf0c93bd062025aa.tar.gz qemu-5e03548bf222b0f8038dc61dbf0c93bd062025aa.tar.bz2 | |
storage-daemon/qapi/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-11-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
| -rw-r--r-- | storage-daemon/qapi/qapi-schema.json | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/storage-daemon/qapi/qapi-schema.json b/storage-daemon/qapi/qapi-schema.json index 2a562ee..0427594 100644 --- a/storage-daemon/qapi/qapi-schema.json +++ b/storage-daemon/qapi/qapi-schema.json @@ -14,10 +14,26 @@ # storage daemon. ## -# = QEMU storage daemon protocol commands and structs +# = Introduction # -# For a concise listing of all commands, events, and types in the QEMU -# storage daemon, please consult the `qapi-qsd-index`. +# This manual describes the commands and events supported by the QEMU +# storage daemon QMP. +# +# For locating a particular item, please see the `qapi-qsd-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. ## |