mirror of https://github.com/xemu-project/xemu.git
qapi: Refill doc comments to conform to conventions
Sweep the entire documentation again. Last done in commit209e64d9ed(qapi: Refill doc comments to conform to current conventions). 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: <20240729065220.860163-1-armbru@redhat.com> [Straightforward conflict with commit442110bc6fresolved]
This commit is contained in:
Markus Armbruster
parent
f9851d2ffe
commit
01bed0ff14
|
|
@ -1160,9 +1160,9 @@
|
|||
# that have a node name, in a list which will include "parent"
|
||||
# information, but not "backing". If false or omitted, the
|
||||
# behavior is as before - query all the device backends,
|
||||
# recursively including their "parent" and "backing". Filter nodes
|
||||
# that were created implicitly are skipped over in this mode.
|
||||
# (Since 2.3)
|
||||
# recursively including their "parent" and "backing". Filter
|
||||
# nodes that were created implicitly are skipped over in this
|
||||
# mode. (Since 2.3)
|
||||
#
|
||||
# Returns: A list of @BlockStats for each virtual block devices.
|
||||
#
|
||||
|
|
@ -1619,9 +1619,9 @@
|
|||
#
|
||||
# @unstable: Member @x-perf is experimental.
|
||||
#
|
||||
# .. note:: @on-source-error and @on-target-error only affect background
|
||||
# I/O. If an error occurs during a guest write request, the device's
|
||||
# rerror/werror actions will be used.
|
||||
# .. note:: @on-source-error and @on-target-error only affect
|
||||
# background I/O. If an error occurs during a guest write request,
|
||||
# the device's rerror/werror actions will be used.
|
||||
#
|
||||
# Since: 4.2
|
||||
##
|
||||
|
|
@ -1882,8 +1882,8 @@
|
|||
# Start a point-in-time copy of a block device to a new destination.
|
||||
# The status of ongoing drive-backup operations can be checked with
|
||||
# query-block-jobs where the BlockJobInfo.type field has the value
|
||||
# 'backup'. The operation can be stopped before it has completed using
|
||||
# the block-job-cancel command.
|
||||
# 'backup'. The operation can be stopped before it has completed
|
||||
# using the block-job-cancel command.
|
||||
#
|
||||
# Features:
|
||||
#
|
||||
|
|
@ -1913,8 +1913,8 @@
|
|||
# Start a point-in-time copy of a block device to a new destination.
|
||||
# The status of ongoing blockdev-backup operations can be checked with
|
||||
# query-block-jobs where the BlockJobInfo.type field has the value
|
||||
# 'backup'. The operation can be stopped before it has completed using
|
||||
# the block-job-cancel command.
|
||||
# 'backup'. The operation can be stopped before it has completed
|
||||
# using the block-job-cancel command.
|
||||
#
|
||||
# Errors:
|
||||
# - If @device is not a valid block device, DeviceNotFound
|
||||
|
|
@ -3034,8 +3034,8 @@
|
|||
# semantics.
|
||||
#
|
||||
# This command will refuse to operate on any job that has not yet
|
||||
# reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that make
|
||||
# use of the BLOCK_JOB_READY event, block-job-cancel or
|
||||
# reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that
|
||||
# make use of the BLOCK_JOB_READY event, block-job-cancel or
|
||||
# block-job-complete will still need to be used as appropriate.
|
||||
#
|
||||
# @id: The job identifier.
|
||||
|
|
@ -4050,6 +4050,7 @@
|
|||
# @path: path to the vhost-vdpa character device.
|
||||
#
|
||||
# Features:
|
||||
#
|
||||
# @fdset: Member @path supports the special "/dev/fdset/N" path
|
||||
# (since 8.1)
|
||||
#
|
||||
|
|
@ -5231,8 +5232,8 @@
|
|||
# monolithcFlat, twoGbMaxExtentSparse and twoGbMaxExtentFlat
|
||||
# formats. For monolithicFlat, only one entry is required; for
|
||||
# twoGbMaxExtent* formats, the number of entries required is
|
||||
# calculated as extent_number = virtual_size / 2GB. Providing more
|
||||
# extents than will be used is an error.
|
||||
# calculated as extent_number = virtual_size / 2GB. Providing
|
||||
# more extents than will be used is an error.
|
||||
#
|
||||
# @subformat: The subformat of the VMDK image. Default:
|
||||
# "monolithicSparse".
|
||||
|
|
@ -5543,8 +5544,8 @@
|
|||
# after this event and must be repaired (Since 2.2; before, every
|
||||
# BLOCK_IMAGE_CORRUPTED event was fatal)
|
||||
#
|
||||
# .. note:: If action is "stop", a STOP event will eventually follow the
|
||||
# BLOCK_IO_ERROR event.
|
||||
# .. note:: If action is "stop", a STOP event will eventually follow
|
||||
# the BLOCK_IO_ERROR event.
|
||||
#
|
||||
# .. qmp-example::
|
||||
#
|
||||
|
|
@ -5590,8 +5591,8 @@
|
|||
# field is a debugging aid for humans, it should not be parsed by
|
||||
# applications) (since: 2.2)
|
||||
#
|
||||
# .. note:: If action is "stop", a STOP event will eventually follow the
|
||||
# BLOCK_IO_ERROR event.
|
||||
# .. note:: If action is "stop", a STOP event will eventually follow
|
||||
# the BLOCK_IO_ERROR event.
|
||||
#
|
||||
# Since: 0.13
|
||||
#
|
||||
|
|
@ -6046,9 +6047,9 @@
|
|||
#
|
||||
# @name: the name of the internal snapshot to be created
|
||||
#
|
||||
# .. note:: In a transaction, if @name is empty or any snapshot matching
|
||||
# @name exists, the operation will fail. Only some image formats
|
||||
# support it; for example, qcow2, and rbd.
|
||||
# .. note:: In a transaction, if @name is empty or any snapshot
|
||||
# matching @name exists, the operation will fail. Only some image
|
||||
# formats support it; for example, qcow2, and rbd.
|
||||
#
|
||||
# Since: 1.7
|
||||
##
|
||||
|
|
|
|||
|
|
@ -163,8 +163,8 @@
|
|||
# Options for exporting a block graph node on some (file) mountpoint
|
||||
# as a raw image.
|
||||
#
|
||||
# @mountpoint: Path on which to export the block device via FUSE. This
|
||||
# must point to an existing regular file.
|
||||
# @mountpoint: Path on which to export the block device via FUSE.
|
||||
# This must point to an existing regular file.
|
||||
#
|
||||
# @growable: Whether writes beyond the EOF should grow the block node
|
||||
# accordingly. (default: false)
|
||||
|
|
|
|||
|
|
@ -454,8 +454,8 @@
|
|||
# different group. In this case the limits specified in the
|
||||
# parameters will be applied to the new group only.
|
||||
#
|
||||
# I/O limits can be disabled by setting all of them to 0. In this case
|
||||
# the device will be removed from its group and the rest of its
|
||||
# I/O limits can be disabled by setting all of them to 0. In this
|
||||
# case the device will be removed from its group and the rest of its
|
||||
# members will not be affected. The 'group' parameter is ignored.
|
||||
#
|
||||
# Errors:
|
||||
|
|
@ -519,10 +519,10 @@
|
|||
# @id: The name or QOM path of the guest device.
|
||||
#
|
||||
# @boundaries: list of interval boundary values (see description in
|
||||
# BlockLatencyHistogramInfo definition). If specified, all latency
|
||||
# histograms are removed, and empty ones created for all io types
|
||||
# with intervals corresponding to @boundaries (except for io
|
||||
# types, for which specific boundaries are set through the
|
||||
# BlockLatencyHistogramInfo definition). If specified, all
|
||||
# latency histograms are removed, and empty ones created for all
|
||||
# io types with intervals corresponding to @boundaries (except for
|
||||
# io types, for which specific boundaries are set through the
|
||||
# following parameters).
|
||||
#
|
||||
# @boundaries-read: list of interval boundary values for read latency
|
||||
|
|
|
|||
|
|
@ -388,9 +388,9 @@
|
|||
#
|
||||
# @rows: console height, in chars
|
||||
#
|
||||
# .. note:: The options are only effective when the VNC or SDL graphical
|
||||
# display backend is active. They are ignored with the GTK, Spice,
|
||||
# VNC and D-Bus display backends.
|
||||
# .. note:: The options are only effective when the VNC or SDL
|
||||
# graphical display backend is active. They are ignored with the
|
||||
# GTK, Spice, VNC and D-Bus display backends.
|
||||
#
|
||||
# Since: 1.5
|
||||
##
|
||||
|
|
|
|||
|
|
@ -22,13 +22,14 @@
|
|||
# "arguments": { "enable": [ "oob" ] } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
# .. note:: This command is valid exactly when first connecting: it must
|
||||
# be issued before any other command will be accepted, and will fail
|
||||
# once the monitor is accepting other commands.
|
||||
# (see :doc:`/interop/qmp-spec`)
|
||||
# .. note:: This command is valid exactly when first connecting: it
|
||||
# must be issued before any other command will be accepted, and
|
||||
# will fail once the monitor is accepting other commands. (see
|
||||
# :doc:`/interop/qmp-spec`)
|
||||
#
|
||||
# .. note:: The QMP client needs to explicitly enable QMP capabilities,
|
||||
# otherwise all the QMP capabilities will be turned off by default.
|
||||
# .. note:: The QMP client needs to explicitly enable QMP
|
||||
# capabilities, otherwise all the QMP capabilities will be turned
|
||||
# off by default.
|
||||
#
|
||||
# Since: 0.13
|
||||
##
|
||||
|
|
@ -150,7 +151,6 @@
|
|||
# }
|
||||
#
|
||||
# This example has been shortened as the real response is too long.
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-commands', 'returns': ['CommandInfo'],
|
||||
'allow-preconfig': true }
|
||||
|
|
|
|||
|
|
@ -369,8 +369,8 @@
|
|||
# of memory by Device Physical Address within a single Dynamic
|
||||
# Capacity Region on a CXL Type 3 Device.
|
||||
#
|
||||
# @offset: The offset (in bytes) to the start of the region
|
||||
# where the extent belongs to.
|
||||
# @offset: The offset (in bytes) to the start of the region where the
|
||||
# extent belongs to.
|
||||
#
|
||||
# @len: The length of the extent in bytes.
|
||||
#
|
||||
|
|
@ -404,16 +404,16 @@
|
|||
#
|
||||
# @enable-shared-access: Capacity has already been allocated to a
|
||||
# different host using free, contiguous or prescriptive policy
|
||||
# with a known tag. This policy then instructs the device to
|
||||
# make the capacity with the specified tag available to an
|
||||
# additional host. Capacity is implicit as it matches that
|
||||
# already associated with the tag. Note that the extent list
|
||||
# (and hence Device Physical Addresses) used are per host, so
|
||||
# a device may use different representations on each host.
|
||||
# The ordering of the extents provided to each host is indicated
|
||||
# to the host using per extent sequence numbers generated by
|
||||
# the device. Has a similar meaning for temporal sharing, but
|
||||
# in that case there may be only one host involved.
|
||||
# with a known tag. This policy then instructs the device to make
|
||||
# the capacity with the specified tag available to an additional
|
||||
# host. Capacity is implicit as it matches that already
|
||||
# associated with the tag. Note that the extent list (and hence
|
||||
# Device Physical Addresses) used are per host, so a device may
|
||||
# use different representations on each host. The ordering of the
|
||||
# extents provided to each host is indicated to the host using per
|
||||
# extent sequence numbers generated by the device. Has a similar
|
||||
# meaning for temporal sharing, but in that case there may be only
|
||||
# one host involved.
|
||||
#
|
||||
# Since: 9.1
|
||||
##
|
||||
|
|
@ -514,13 +514,13 @@
|
|||
# from the host. Instead, the host immediately looses access to
|
||||
# the released capacity.
|
||||
#
|
||||
# @sanitize-on-release: Bit[5] of the "Flags" field in Compute
|
||||
# Express Link (CXL) Specification, Revision 3.1, Table 7-71.
|
||||
# When set, the device should sanitize all released capacity as
|
||||
# a result of this request. This ensures that all user data
|
||||
# and metadata is made permanently unavailable by whatever
|
||||
# means is appropriate for the media type. Note that changing
|
||||
# encryption keys is not sufficient.
|
||||
# @sanitize-on-release: Bit[5] of the "Flags" field in Compute Express
|
||||
# Link (CXL) Specification, Revision 3.1, Table 7-71. When set,
|
||||
# the device should sanitize all released capacity as a result of
|
||||
# this request. This ensures that all user data and metadata is
|
||||
# made permanently unavailable by whatever means is appropriate
|
||||
# for the media type. Note that changing encryption keys is not
|
||||
# sufficient.
|
||||
#
|
||||
# @region: The "Region Number" field as defined in Compute Express
|
||||
# Link Specification, Revision 3.1, Table 7-71. Valid range
|
||||
|
|
|
|||
|
|
@ -42,8 +42,8 @@
|
|||
# with different meta-types).
|
||||
#
|
||||
# .. note:: The QAPI schema is also used to help define *internal*
|
||||
# interfaces, by defining QAPI types. These are not part of the QMP
|
||||
# wire ABI, and therefore not returned by this command.
|
||||
# interfaces, by defining QAPI types. These are not part of the
|
||||
# QMP wire ABI, and therefore not returned by this command.
|
||||
#
|
||||
# Since: 2.5
|
||||
##
|
||||
|
|
|
|||
|
|
@ -200,9 +200,9 @@
|
|||
# dismiss enabled.
|
||||
#
|
||||
# This command will refuse to operate on any job that has not yet
|
||||
# reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that make
|
||||
# use of JOB_READY event, job-cancel or job-complete will still need
|
||||
# to be used as appropriate.
|
||||
# reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that
|
||||
# make use of JOB_READY event, job-cancel or job-complete will still
|
||||
# need to be used as appropriate.
|
||||
#
|
||||
# @id: The job identifier.
|
||||
#
|
||||
|
|
|
|||
|
|
@ -12,9 +12,10 @@
|
|||
# Virtual CPU model.
|
||||
#
|
||||
# A CPU model consists of the name of a CPU definition, to which delta
|
||||
# changes are applied (e.g. features added/removed). Most magic values
|
||||
# that an architecture might require should be hidden behind the name.
|
||||
# However, if required, architectures can expose relevant properties.
|
||||
# changes are applied (e.g. features added/removed). Most magic
|
||||
# values that an architecture might require should be hidden behind
|
||||
# the name. However, if required, architectures can expose relevant
|
||||
# properties.
|
||||
#
|
||||
# @name: the name of the CPU definition the model is based on
|
||||
#
|
||||
|
|
@ -46,13 +47,13 @@
|
|||
#
|
||||
# .. note:: When a non-migration-safe CPU model is expanded in static
|
||||
# mode, some features enabled by the CPU model may be omitted,
|
||||
# because they can't be implemented by a static CPU model definition
|
||||
# (e.g. cache info passthrough and PMU passthrough in x86). If you
|
||||
# need an accurate representation of the features enabled by a
|
||||
# non-migration-safe CPU model, use @full. If you need a static
|
||||
# representation that will keep ABI compatibility even when changing
|
||||
# QEMU version or machine-type, use @static (but keep in mind that
|
||||
# some features may be omitted).
|
||||
# because they can't be implemented by a static CPU model
|
||||
# definition (e.g. cache info passthrough and PMU passthrough in
|
||||
# x86). If you need an accurate representation of the features
|
||||
# enabled by a non-migration-safe CPU model, use @full. If you
|
||||
# need a static representation that will keep ABI compatibility
|
||||
# even when changing QEMU version or machine-type, use @static (but
|
||||
# keep in mind that some features may be omitted).
|
||||
#
|
||||
# Since: 2.8
|
||||
##
|
||||
|
|
@ -155,11 +156,11 @@
|
|||
# Some architectures may not support comparing CPU models. s390x
|
||||
# supports comparing CPU models.
|
||||
#
|
||||
# @modela: description of the first CPU model to compare, referred to as
|
||||
# "model A" in CpuModelCompareResult
|
||||
# @modela: description of the first CPU model to compare, referred to
|
||||
# as "model A" in CpuModelCompareResult
|
||||
#
|
||||
# @modelb: description of the second CPU model to compare, referred to as
|
||||
# "model B" in CpuModelCompareResult
|
||||
# @modelb: description of the second CPU model to compare, referred to
|
||||
# as "model B" in CpuModelCompareResult
|
||||
#
|
||||
# Returns: a CpuModelCompareInfo describing how both CPU models
|
||||
# compare
|
||||
|
|
@ -185,7 +186,8 @@
|
|||
#
|
||||
# Baseline two CPU models, @modela and @modelb, creating a compatible
|
||||
# third model. The created model will always be a static,
|
||||
# migration-safe CPU model (see "static" CPU model expansion for details).
|
||||
# migration-safe CPU model (see "static" CPU model expansion for
|
||||
# details).
|
||||
#
|
||||
# This interface can be used by tooling to create a compatible CPU
|
||||
# model out two CPU models. The created CPU model will be identical
|
||||
|
|
@ -242,12 +244,12 @@
|
|||
#
|
||||
# @model: the expanded CpuModelInfo.
|
||||
#
|
||||
# @deprecated-props: a list of properties that are flagged as deprecated
|
||||
# by the CPU vendor. The list depends on the CpuModelExpansionType:
|
||||
# "static" properties are a subset of the enabled-properties for
|
||||
# the expanded model; "full" properties are a set of properties
|
||||
# that are deprecated across all models for the architecture.
|
||||
# (since: 9.1).
|
||||
# @deprecated-props: a list of properties that are flagged as
|
||||
# deprecated by the CPU vendor. The list depends on the
|
||||
# CpuModelExpansionType: "static" properties are a subset of the
|
||||
# enabled-properties for the expanded model; "full" properties are
|
||||
# a set of properties that are deprecated across all models for
|
||||
# the architecture. (since: 9.1).
|
||||
#
|
||||
# Since: 2.8
|
||||
##
|
||||
|
|
@ -265,9 +267,9 @@
|
|||
# @query-cpu-model-expansion:
|
||||
#
|
||||
# Expands a given CPU model, @model, (or a combination of CPU model +
|
||||
# additional options) to different granularities, specified by
|
||||
# @type, allowing tooling to get an understanding what a specific
|
||||
# CPU model looks like in QEMU under a certain configuration.
|
||||
# additional options) to different granularities, specified by @type,
|
||||
# allowing tooling to get an understanding what a specific CPU model
|
||||
# looks like in QEMU under a certain configuration.
|
||||
#
|
||||
# This interface can be used to query the "host" CPU model.
|
||||
#
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@
|
|||
# @loongarch64: since 7.1
|
||||
#
|
||||
# .. note:: The resulting QMP strings can be appended to the
|
||||
# "qemu-system-" prefix to produce the corresponding QEMU executable
|
||||
# name. This is true even for "qemu-system-x86_64".
|
||||
# "qemu-system-" prefix to produce the corresponding QEMU
|
||||
# executable name. This is true even for "qemu-system-x86_64".
|
||||
#
|
||||
# Since: 3.0
|
||||
##
|
||||
|
|
@ -371,8 +371,8 @@
|
|||
#
|
||||
# .. note:: A guest may or may not respond to this command. This
|
||||
# command returning does not indicate that a guest has accepted the
|
||||
# request or that it has shut down. Many guests will respond to this
|
||||
# command by prompting the user in some way.
|
||||
# request or that it has shut down. Many guests will respond to
|
||||
# this command by prompting the user in some way.
|
||||
#
|
||||
# .. qmp-example::
|
||||
#
|
||||
|
|
@ -988,8 +988,8 @@
|
|||
# @cluster-id: cluster number within the parent container the CPU
|
||||
# belongs to (since 7.1)
|
||||
#
|
||||
# @module-id: module number within the parent container the CPU belongs
|
||||
# to (since 9.1)
|
||||
# @module-id: module number within the parent container the CPU
|
||||
# belongs to (since 9.1)
|
||||
#
|
||||
# @core-id: core number within the parent container the CPU belongs to
|
||||
#
|
||||
|
|
@ -1132,8 +1132,8 @@
|
|||
# - If no balloon device is present, DeviceNotActive
|
||||
#
|
||||
# .. note:: This command just issues a request to the guest. When it
|
||||
# returns, the balloon size may not have changed. A guest can change
|
||||
# the balloon size independent of this command.
|
||||
# returns, the balloon size may not have changed. A guest can
|
||||
# change the balloon size independent of this command.
|
||||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
|
|
@ -1659,8 +1659,8 @@
|
|||
# The members other than @cpus and @maxcpus define a topology of
|
||||
# containers.
|
||||
#
|
||||
# The ordering from highest/coarsest to lowest/finest is:
|
||||
# @drawers, @books, @sockets, @dies, @clusters, @cores, @threads.
|
||||
# The ordering from highest/coarsest to lowest/finest is: @drawers,
|
||||
# @books, @sockets, @dies, @clusters, @cores, @threads.
|
||||
#
|
||||
# Different architectures support different subsets of topology
|
||||
# containers.
|
||||
|
|
|
|||
|
|
@ -142,8 +142,8 @@
|
|||
#
|
||||
# @postcopy-paused: during postcopy but paused. (since 3.0)
|
||||
#
|
||||
# @postcopy-recover-setup: setup phase for a postcopy recovery process,
|
||||
# preparing for a recovery phase to start. (since 9.1)
|
||||
# @postcopy-recover-setup: setup phase for a postcopy recovery
|
||||
# process, preparing for a recovery phase to start. (since 9.1)
|
||||
#
|
||||
# @postcopy-recover: trying to recover from a paused postcopy. (since
|
||||
# 3.0)
|
||||
|
|
@ -245,10 +245,10 @@
|
|||
# blocked. Present and non-empty when migration is blocked.
|
||||
# (since 6.0)
|
||||
#
|
||||
# @dirty-limit-throttle-time-per-round: Maximum throttle time
|
||||
# (in microseconds) of virtual CPUs each dirty ring full round,
|
||||
# which shows how MigrationCapability dirty-limit affects the
|
||||
# guest during live migration. (Since 8.1)
|
||||
# @dirty-limit-throttle-time-per-round: Maximum throttle time (in
|
||||
# microseconds) of virtual CPUs each dirty ring full round, which
|
||||
# shows how MigrationCapability dirty-limit affects the guest
|
||||
# during live migration. (Since 8.1)
|
||||
#
|
||||
# @dirty-limit-ring-full-time: Estimated average dirty ring full time
|
||||
# (in microseconds) for each dirty ring full round. The value
|
||||
|
|
@ -393,8 +393,8 @@
|
|||
# efficiently. This essentially saves 1MB of zeroes per block on
|
||||
# the wire. Enabling requires source and target VM to support
|
||||
# this feature. To enable it is sufficient to enable the
|
||||
# capability on the source VM. The feature is disabled by default.
|
||||
# (since 1.6)
|
||||
# capability on the source VM. The feature is disabled by
|
||||
# default. (since 1.6)
|
||||
#
|
||||
# @events: generate events for each migration state change (since 2.4)
|
||||
#
|
||||
|
|
@ -563,8 +563,8 @@
|
|||
#
|
||||
# @qpl: use qpl compression method. Query Processing Library(qpl) is
|
||||
# based on the deflate compression algorithm and use the Intel
|
||||
# In-Memory Analytics Accelerator(IAA) accelerated compression
|
||||
# and decompression. (Since 9.1)
|
||||
# In-Memory Analytics Accelerator(IAA) accelerated compression and
|
||||
# decompression. (Since 9.1)
|
||||
#
|
||||
# @uadk: use UADK library compression method. (Since 9.1)
|
||||
#
|
||||
|
|
@ -1459,8 +1459,8 @@
|
|||
#
|
||||
# Cancel the current executing migration process.
|
||||
#
|
||||
# .. note:: This command succeeds even if there is no migration process
|
||||
# running.
|
||||
# .. note:: This command succeeds even if there is no migration
|
||||
# process running.
|
||||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
|
|
@ -1650,7 +1650,6 @@
|
|||
# "filename": "/tmp/migfile",
|
||||
# "offset": "0x1000" } } ] } }
|
||||
# <- { "return": {} }
|
||||
#
|
||||
##
|
||||
{ 'command': 'migrate',
|
||||
'data': {'*uri': 'str',
|
||||
|
|
@ -1671,7 +1670,8 @@
|
|||
#
|
||||
# @exit-on-error: Exit on incoming migration failure. Default true.
|
||||
# When set to false, the failure triggers a MIGRATION event, and
|
||||
# error details could be retrieved with query-migrate. (since 9.1)
|
||||
# error details could be retrieved with query-migrate.
|
||||
# (since 9.1)
|
||||
#
|
||||
# Since: 2.3
|
||||
#
|
||||
|
|
@ -1938,9 +1938,9 @@
|
|||
# @UNPLUG_PRIMARY:
|
||||
#
|
||||
# Emitted from source side of a migration when migration state is
|
||||
# WAIT_UNPLUG. Device was unplugged by guest operating system. Device
|
||||
# resources in QEMU are kept on standby to be able to re-plug it in
|
||||
# case of migration failure.
|
||||
# WAIT_UNPLUG. Device was unplugged by guest operating system.
|
||||
# Device resources in QEMU are kept on standby to be able to re-plug
|
||||
# it in case of migration failure.
|
||||
#
|
||||
# @device-id: QEMU device id of the unplugged device
|
||||
#
|
||||
|
|
@ -2084,16 +2084,16 @@
|
|||
# This mode tracks page modification per each vCPU separately. It
|
||||
# requires that KVM accelerator property "dirty-ring-size" is set.
|
||||
#
|
||||
# @calc-time: time period for which dirty page rate is calculated.
|
||||
# By default it is specified in seconds, but the unit can be set
|
||||
# @calc-time: time period for which dirty page rate is calculated. By
|
||||
# default it is specified in seconds, but the unit can be set
|
||||
# explicitly with @calc-time-unit. Note that larger @calc-time
|
||||
# values will typically result in smaller dirty page rates because
|
||||
# page dirtying is a one-time event. Once some page is counted
|
||||
# as dirty during @calc-time period, further writes to this page
|
||||
# will not increase dirty page rate anymore.
|
||||
# page dirtying is a one-time event. Once some page is counted as
|
||||
# dirty during @calc-time period, further writes to this page will
|
||||
# not increase dirty page rate anymore.
|
||||
#
|
||||
# @calc-time-unit: time unit in which @calc-time is specified.
|
||||
# By default it is seconds. (Since 8.2)
|
||||
# @calc-time-unit: time unit in which @calc-time is specified. By
|
||||
# default it is seconds. (Since 8.2)
|
||||
#
|
||||
# @sample-pages: number of sampled pages per each GiB of guest memory.
|
||||
# Default value is 512. For 4KiB guest pages this corresponds to
|
||||
|
|
|
|||
|
|
@ -104,8 +104,8 @@
|
|||
# Returns a list of information about each iothread.
|
||||
#
|
||||
# .. note:: This list excludes the QEMU main loop thread, which is not
|
||||
# declared using the ``-object iothread`` command-line option. It is
|
||||
# always the main thread of the process.
|
||||
# declared using the ``-object iothread`` command-line option. It
|
||||
# is always the main thread of the process.
|
||||
#
|
||||
# Returns: a list of @IOThreadInfo for each iothread
|
||||
#
|
||||
|
|
@ -141,8 +141,8 @@
|
|||
# guest remains paused once migration finishes, as if the ``-S``
|
||||
# option was passed on the command line.
|
||||
#
|
||||
# In the "suspended" state, it will completely stop the VM and cause
|
||||
# a transition to the "paused" state. (Since 9.0)
|
||||
# In the "suspended" state, it will completely stop the VM and
|
||||
# cause a transition to the "paused" state. (Since 9.0)
|
||||
#
|
||||
# .. qmp-example::
|
||||
#
|
||||
|
|
@ -158,15 +158,15 @@
|
|||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
# .. note:: This command will succeed if the guest is currently running.
|
||||
# It will also succeed if the guest is in the "inmigrate" state; in
|
||||
# this case, the effect of the command is to make sure the guest
|
||||
# starts once migration finishes, removing the effect of the ``-S``
|
||||
# command line option if it was passed.
|
||||
# .. note:: This command will succeed if the guest is currently
|
||||
# running. It will also succeed if the guest is in the "inmigrate"
|
||||
# state; in this case, the effect of the command is to make sure
|
||||
# the guest starts once migration finishes, removing the effect of
|
||||
# the ``-S`` command line option if it was passed.
|
||||
#
|
||||
# If the VM was previously suspended, and not been reset or woken,
|
||||
# this command will transition back to the "suspended" state. (Since
|
||||
# 9.0)
|
||||
# this command will transition back to the "suspended" state.
|
||||
# (Since 9.0)
|
||||
#
|
||||
# .. qmp-example::
|
||||
#
|
||||
|
|
@ -227,8 +227,8 @@
|
|||
#
|
||||
# Known limitations:
|
||||
#
|
||||
# * This command is stateless, this means that commands that
|
||||
# depend on state information (such as getfd) might not work.
|
||||
# * This command is stateless, this means that commands that depend
|
||||
# on state information (such as getfd) might not work.
|
||||
#
|
||||
# * Commands that prompt the user for data don't currently work.
|
||||
#
|
||||
|
|
@ -341,7 +341,8 @@
|
|||
#
|
||||
# .. note:: The list of fd sets is shared by all monitor connections.
|
||||
#
|
||||
# .. note:: If @fdset-id is not specified, a new fd set will be created.
|
||||
# .. note:: If @fdset-id is not specified, a new fd set will be
|
||||
# created.
|
||||
#
|
||||
# Since: 1.2
|
||||
#
|
||||
|
|
|
|||
|
|
@ -22,9 +22,9 @@
|
|||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
# .. note:: Not all network adapters support setting link status. This
|
||||
# command will succeed even if the network adapter does not support
|
||||
# link status notification.
|
||||
# .. note:: Not all network adapters support setting link status.
|
||||
# This command will succeed even if the network adapter does not
|
||||
# support link status notification.
|
||||
#
|
||||
# .. qmp-example::
|
||||
#
|
||||
|
|
@ -703,12 +703,19 @@
|
|||
# Available netdev drivers.
|
||||
#
|
||||
# @l2tpv3: since 2.1
|
||||
#
|
||||
# @vhost-vdpa: since 5.1
|
||||
#
|
||||
# @vmnet-host: since 7.1
|
||||
#
|
||||
# @vmnet-shared: since 7.1
|
||||
#
|
||||
# @vmnet-bridged: since 7.1
|
||||
#
|
||||
# @stream: since 7.2
|
||||
#
|
||||
# @dgram: since 7.2
|
||||
#
|
||||
# @af-xdp: since 8.2
|
||||
#
|
||||
# Since: 2.7
|
||||
|
|
|
|||
|
|
@ -310,6 +310,5 @@
|
|||
# }
|
||||
#
|
||||
# This example has been shortened as the real response is too long.
|
||||
#
|
||||
##
|
||||
{ 'command': 'query-pci', 'returns': ['PciInfo'] }
|
||||
|
|
|
|||
|
|
@ -59,8 +59,8 @@
|
|||
# the 'docs/qdev-device-use.txt' file.
|
||||
#
|
||||
# 3. It's possible to list device properties by running QEMU with
|
||||
# the ``-device DEVICE,help`` command-line argument, where DEVICE
|
||||
# is the device's name.
|
||||
# the ``-device DEVICE,help`` command-line argument, where
|
||||
# DEVICE is the device's name.
|
||||
#
|
||||
# .. qmp-example::
|
||||
#
|
||||
|
|
@ -94,13 +94,13 @@
|
|||
#
|
||||
# .. note:: When this command completes, the device may not be removed
|
||||
# from the guest. Hot removal is an operation that requires guest
|
||||
# cooperation. This command merely requests that the guest begin the
|
||||
# hot removal process. Completion of the device removal process is
|
||||
# signaled with a DEVICE_DELETED event. Guest reset will
|
||||
# automatically complete removal for all devices. If a guest-side
|
||||
# error in the hot removal process is detected, the device will not
|
||||
# be removed and a DEVICE_UNPLUG_GUEST_ERROR event is sent. Some
|
||||
# errors cannot be detected.
|
||||
# cooperation. This command merely requests that the guest begin
|
||||
# the hot removal process. Completion of the device removal
|
||||
# process is signaled with a DEVICE_DELETED event. Guest reset
|
||||
# will automatically complete removal for all devices. If a
|
||||
# guest-side error in the hot removal process is detected, the
|
||||
# device will not be removed and a DEVICE_UNPLUG_GUEST_ERROR event
|
||||
# is sent. Some errors cannot be detected.
|
||||
#
|
||||
# Since: 0.14
|
||||
#
|
||||
|
|
|
|||
|
|
@ -620,8 +620,8 @@
|
|||
# .. note:: prealloc=true and reserve=false cannot be set at the same
|
||||
# time. With reserve=true, the behavior depends on the operating
|
||||
# system: for example, Linux will not reserve swap space for shared
|
||||
# file mappings -- "not applicable". In contrast, reserve=false will
|
||||
# bail out if it cannot be configured accordingly.
|
||||
# file mappings -- "not applicable". In contrast, reserve=false
|
||||
# will bail out if it cannot be configured accordingly.
|
||||
#
|
||||
# Since: 2.1
|
||||
##
|
||||
|
|
@ -646,9 +646,9 @@
|
|||
# @align: the base address alignment when QEMU mmap(2)s @mem-path.
|
||||
# Some backend stores specified by @mem-path require an alignment
|
||||
# different than the default one used by QEMU, e.g. the device DAX
|
||||
# /dev/dax0.0 requires 2M alignment rather than 4K. In such cases,
|
||||
# users can specify the required alignment via this option. 0
|
||||
# selects a default alignment (currently the page size).
|
||||
# /dev/dax0.0 requires 2M alignment rather than 4K. In such
|
||||
# cases, users can specify the required alignment via this option.
|
||||
# 0 selects a default alignment (currently the page size).
|
||||
# (default: 0)
|
||||
#
|
||||
# @offset: the offset into the target file that the region starts at.
|
||||
|
|
@ -930,16 +930,16 @@
|
|||
#
|
||||
# @handle: SEV firmware handle (default: 0)
|
||||
#
|
||||
# @legacy-vm-type: Use legacy KVM_SEV_INIT KVM interface for creating the VM.
|
||||
# The newer KVM_SEV_INIT2 interface, from Linux >= 6.10, syncs
|
||||
# additional vCPU state when initializing the VMSA structures,
|
||||
# which will result in a different guest measurement. Set
|
||||
# this to 'on' to force compatibility with older QEMU or kernel
|
||||
# versions that rely on legacy KVM_SEV_INIT behavior. 'auto'
|
||||
# will behave identically to 'on', but will automatically
|
||||
# switch to using KVM_SEV_INIT2 if the user specifies any
|
||||
# additional options that require it. If set to 'off', QEMU
|
||||
# will require KVM_SEV_INIT2 unconditionally.
|
||||
# @legacy-vm-type: Use legacy KVM_SEV_INIT KVM interface for creating
|
||||
# the VM. The newer KVM_SEV_INIT2 interface, from Linux >= 6.10,
|
||||
# syncs additional vCPU state when initializing the VMSA
|
||||
# structures, which will result in a different guest measurement.
|
||||
# Set this to 'on' to force compatibility with older QEMU or kernel
|
||||
# versions that rely on legacy KVM_SEV_INIT behavior. 'auto' will
|
||||
# behave identically to 'on', but will automatically switch to
|
||||
# using KVM_SEV_INIT2 if the user specifies any additional options
|
||||
# that require it. If set to 'off', QEMU will require
|
||||
# KVM_SEV_INIT2 unconditionally.
|
||||
# (default: off) (since 9.1)
|
||||
#
|
||||
# Since: 2.12
|
||||
|
|
|
|||
|
|
@ -288,8 +288,8 @@
|
|||
#
|
||||
# @ttl-check: perform TTL check
|
||||
#
|
||||
# .. note:: Optional members may or may not appear in the group depending
|
||||
# if they're relevant to the group type.
|
||||
# .. note:: Optional members may or may not appear in the group
|
||||
# depending if they're relevant to the group type.
|
||||
#
|
||||
# Since: 2.4
|
||||
##
|
||||
|
|
|
|||
|
|
@ -530,8 +530,8 @@
|
|||
# an error code.
|
||||
#
|
||||
# @arg2: for Windows, first argument of the STOP. For Linux, the
|
||||
# guest OS ID, which has the kernel version in bits 16-47
|
||||
# and 0x8100 in bits 48-63.
|
||||
# guest OS ID, which has the kernel version in bits 16-47 and
|
||||
# 0x8100 in bits 48-63.
|
||||
#
|
||||
# @arg3: for Windows, second argument of the STOP. For Linux, the
|
||||
# program counter of the guest.
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@
|
|||
# @InetSocketAddressBase:
|
||||
#
|
||||
# @host: host part of the address
|
||||
#
|
||||
# @port: port part of the address
|
||||
##
|
||||
{ 'struct': 'InetSocketAddressBase',
|
||||
|
|
@ -104,8 +105,8 @@
|
|||
#
|
||||
# @port: port
|
||||
#
|
||||
# .. note:: String types are used to allow for possible future hostname
|
||||
# or service resolution support.
|
||||
# .. note:: String types are used to allow for possible future
|
||||
# hostname or service resolution support.
|
||||
#
|
||||
# Since: 2.8
|
||||
##
|
||||
|
|
|
|||
|
|
@ -119,8 +119,8 @@
|
|||
# @target: the kind of objects to query. Note that each possible
|
||||
# target may enable additional filtering options
|
||||
#
|
||||
# @providers: which providers to request statistics from, and optionally
|
||||
# which named values to return within each provider
|
||||
# @providers: which providers to request statistics from, and
|
||||
# optionally which named values to return within each provider
|
||||
#
|
||||
# Since: 7.1
|
||||
##
|
||||
|
|
|
|||
|
|
@ -238,8 +238,8 @@
|
|||
# - Any errors from commands in the transaction
|
||||
#
|
||||
# .. note:: The transaction aborts on the first failure. Therefore,
|
||||
# there will be information on only one failed operation returned in
|
||||
# an error condition, and subsequent actions will not have been
|
||||
# there will be information on only one failed operation returned
|
||||
# in an error condition, and subsequent actions will not have been
|
||||
# attempted.
|
||||
#
|
||||
# Since: 1.1
|
||||
|
|
|
|||
17
qapi/ui.json
17
qapi/ui.json
|
|
@ -48,8 +48,8 @@
|
|||
# @password: the new password
|
||||
#
|
||||
# @connected: How to handle existing clients when changing the
|
||||
# password. If nothing is specified, defaults to 'keep'. For VNC,
|
||||
# only 'keep' is currently implemented.
|
||||
# password. If nothing is specified, defaults to 'keep'. For
|
||||
# VNC, only 'keep' is currently implemented.
|
||||
#
|
||||
# Since: 7.0
|
||||
##
|
||||
|
|
@ -107,10 +107,11 @@
|
|||
# - '+INT' where INT is the number of seconds from now (integer)
|
||||
# - 'INT' where INT is the absolute time in seconds
|
||||
#
|
||||
# .. note:: Time is relative to the server and currently there is no way
|
||||
# to coordinate server time with client time. It is not recommended
|
||||
# to use the absolute time version of the @time parameter unless
|
||||
# you're sure you are on the same machine as the QEMU instance.
|
||||
# .. note:: Time is relative to the server and currently there is no
|
||||
# way to coordinate server time with client time. It is not
|
||||
# recommended to use the absolute time version of the @time
|
||||
# parameter unless you're sure you are on the same machine as the
|
||||
# QEMU instance.
|
||||
#
|
||||
# Since: 7.0
|
||||
##
|
||||
|
|
@ -719,8 +720,8 @@
|
|||
#
|
||||
# @client: client information
|
||||
#
|
||||
# .. note:: This event is emitted before any authentication takes place,
|
||||
# thus the authentication ID is not provided.
|
||||
# .. note:: This event is emitted before any authentication takes
|
||||
# place, thus the authentication ID is not provided.
|
||||
#
|
||||
# Since: 0.13
|
||||
#
|
||||
|
|
|
|||
|
|
@ -15,16 +15,16 @@
|
|||
#
|
||||
# @running: The device is running.
|
||||
#
|
||||
# @stop-copy: The device is stopped and its internal state is available
|
||||
# for reading.
|
||||
# @stop-copy: The device is stopped and its internal state is
|
||||
# available for reading.
|
||||
#
|
||||
# @resuming: The device is stopped and its internal state is available
|
||||
# for writing.
|
||||
#
|
||||
# @running-p2p: The device is running in the P2P quiescent state.
|
||||
#
|
||||
# @pre-copy: The device is running, tracking its internal state and its
|
||||
# internal state is available for reading.
|
||||
# @pre-copy: The device is running, tracking its internal state and
|
||||
# its internal state is available for reading.
|
||||
#
|
||||
# @pre-copy-p2p: The device is running in the P2P quiescent state,
|
||||
# tracking its internal state and its internal state is available
|
||||
|
|
|
|||
|
|
@ -568,9 +568,9 @@
|
|||
# .. note:: last_avail_idx will not be displayed in the case where the
|
||||
# selected VirtIODevice has a running vhost device and the
|
||||
# VirtIODevice VirtQueue index (queue) does not exist for the
|
||||
# corresponding vhost device vhost_virtqueue. Also, shadow_avail_idx
|
||||
# will not be displayed in the case where the selected VirtIODevice
|
||||
# has a running vhost device.
|
||||
# corresponding vhost device vhost_virtqueue. Also,
|
||||
# shadow_avail_idx will not be displayed in the case where the
|
||||
# selected VirtIODevice has a running vhost device.
|
||||
#
|
||||
# Since: 7.2
|
||||
#
|
||||
|
|
|
|||
Loading…
Reference in New Issue