mirror of
https://gitlab.com/qemu-project/qemu
synced 2024-11-05 20:35:44 +00:00
a937b6aa73
Change
# @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
# do eiusmod tempor incididunt ut labore et dolore magna aliqua.
to
# @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
# do eiusmod tempor incididunt ut labore et dolore magna aliqua.
See recent commit "qapi: Relax doc string @name: description
indentation rules" for rationale.
Reflow paragraphs to 70 columns width, and consistently use two spaces
to separate sentences.
To check the generated documentation does not change, I compared the
generated HTML before and after this commit with "wdiff -3". Finds no
differences. Comparing with diff is not useful, as the reflown
paragraphs are visible there.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-18-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Acked-by: Lukas Straub <lukasstraub2@web.de>
[Straightforward conflicts in qapi/audio.json qapi/misc-target.json
qapi/run-state.json resolved]
80 lines
2.4 KiB
Python
80 lines
2.4 KiB
Python
# -*- Mode: Python -*-
|
|
# vim: filetype=python
|
|
##
|
|
# = Introduction
|
|
#
|
|
# This document describes all commands currently supported by QMP.
|
|
#
|
|
# 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:
|
|
#
|
|
# ::
|
|
#
|
|
# -> data issued by the Client
|
|
# <- Server data response
|
|
#
|
|
# Please, refer to the QMP specification (docs/interop/qmp-spec.txt)
|
|
# for detailed information on the Server command and response formats.
|
|
##
|
|
|
|
{ 'include': 'pragma.json' }
|
|
|
|
# Documentation generated with qapi-gen.py is in source order, with
|
|
# included sub-schemas inserted at the first include directive
|
|
# (subsequent include directives have no effect). To get a sane and
|
|
# stable order, it's best to include each sub-schema just once, or
|
|
# include it first right here.
|
|
|
|
{ 'include': 'error.json' }
|
|
{ 'include': 'common.json' }
|
|
{ 'include': 'sockets.json' }
|
|
{ 'include': 'run-state.json' }
|
|
{ 'include': 'crypto.json' }
|
|
{ 'include': 'job.json' }
|
|
{ 'include': 'block.json' }
|
|
{ 'include': 'block-export.json' }
|
|
{ 'include': 'char.json' }
|
|
{ 'include': 'dump.json' }
|
|
{ 'include': 'net.json' }
|
|
{ 'include': 'rdma.json' }
|
|
{ 'include': 'rocker.json' }
|
|
{ 'include': 'tpm.json' }
|
|
{ 'include': 'ui.json' }
|
|
{ 'include': 'authz.json' }
|
|
{ 'include': 'migration.json' }
|
|
{ 'include': 'transaction.json' }
|
|
{ 'include': 'trace.json' }
|
|
{ 'include': 'compat.json' }
|
|
{ 'include': 'control.json' }
|
|
{ 'include': 'introspect.json' }
|
|
{ 'include': 'qom.json' }
|
|
{ 'include': 'qdev.json' }
|
|
{ 'include': 'machine.json' }
|
|
{ 'include': 'machine-target.json' }
|
|
{ 'include': 'replay.json' }
|
|
{ 'include': 'yank.json' }
|
|
{ 'include': 'misc.json' }
|
|
{ 'include': 'misc-target.json' }
|
|
{ 'include': 'audio.json' }
|
|
{ 'include': 'acpi.json' }
|
|
{ 'include': 'pci.json' }
|
|
{ 'include': 'stats.json' }
|
|
{ 'include': 'virtio.json' }
|
|
{ 'include': 'cryptodev.json' }
|
|
{ 'include': 'cxl.json' }
|