motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-09-01 06:21:52 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi/qapi-schema: Address the introduction's bit rot

Browse source 
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>
This commit is contained in:
Markus Armbruster 2025-04-04 14:14:11 +02:00
parent d0ae5a3058
commit 9199d324a8
1 changed files with 7 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

27
qapi/qapi-schema.json
View file

@ -3,37 +3,24 @@
## ##
# = Introduction # = 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`. # 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 # The following notation is used in examples:
# 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:
# #
# .. qmp-example:: # .. qmp-example::
# #
# -> ... text sent by client (commands) ... # -> ... text sent by client (commands) ...
# <- ... text sent by server (command responses and events) ... # <- ... 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 # Please refer to the
# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>` # :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' } { 'include': 'pragma.json' }