diff options
| author | Markus Armbruster <armbru@redhat.com> | 2025-04-04 14:14:11 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-04-08 09:04:34 +0200 |
| commit | 9199d324a85cd3d4697b5907e804b903b5ce46e3 (patch) | |
| tree | a8f41c93de46c420defba0fc74c8d193608ae0d2 | |
| parent | d0ae5a3058603d4b2c25984a3acb2ac83e025424 (diff) | |
| download | focaccia-qemu-9199d324a85cd3d4697b5907e804b903b5ce46e3.tar.gz focaccia-qemu-9199d324a85cd3d4697b5907e804b903b5ce46e3.zip | |
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 <armbru@redhat.com> Message-ID: <20250404121413.1743790-10-armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com>
Diffstat (limited to '')
| -rw-r--r-- | qapi/qapi-schema.json | 27 |
1 files changed, 7 insertions, 20 deletions
diff --git a/qapi/qapi-schema.json b/qapi/qapi-schema.json index 0d027d5017..7bc600bb76 100644 --- a/qapi/qapi-schema.json +++ b/qapi/qapi-schema.json @@ -3,37 +3,24 @@ ## # = Introduction # -# This document describes all commands currently supported by QMP. +# This manual describes the commands and events supported by the QEMU +# Monitor Protocol (QMP). # # For locating a particular item, please see the `qapi-qmp-index`. # -# Most of the time their usage is exactly the same as in the user -# Monitor, this means that any other document which also describe -# commands (the manpage, QEMU's manual, etc) can and should be -# consulted. -# -# QMP has two types of commands: regular and query commands. Regular -# commands usually change the Virtual Machine's state someway, while -# query commands just return information. The sections below are -# divided accordingly. -# -# It's important to observe that all communication examples are -# formatted in a reader-friendly way, so that they're easier to -# understand. However, in real protocol usage, they're emitted as a -# single line. -# -# Also, the following notation is used to denote data flow: -# -# Example: +# 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 detailed information on the Server command and response formats. +# for the general format of commands, responses, and events. ## { 'include': 'pragma.json' } |