motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-17 07:02:03 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Tidy up whitespace in doc comments

Browse source 
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250527073916.1243024-3-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Markus Armbruster 2025-05-27 09:39:05 +02:00
parent 5e203f73c2
commit 69d68fb34e
8 changed files with 25 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

16
qapi/block-core.json
View file

@ -488,7 +488,7 @@
# #
# @active: true if the backend is active; typical cases for inactive backends # @active: true if the backend is active; typical cases for inactive backends
# are on the migration source instance after migration completes and on the # are on the migration source instance after migration completes and on the
# destination before it completes. (since: 10.0) # destination before it completes. (since: 10.0)
# #
# @encrypted: true if the backing device is encrypted # @encrypted: true if the backing device is encrypted
# #
@ -3030,10 +3030,10 @@
# state. Completing the job in any other state is an error. # state. Completing the job in any other state is an error.
# #
# This is supported only for drive mirroring, where it also switches # This is supported only for drive mirroring, where it also switches
# the device to write to the target path only. Note that drive # the device to write to the target path only. Note that drive
# mirroring includes drive-mirror, blockdev-mirror and block-commit # mirroring includes drive-mirror, blockdev-mirror and block-commit
# job (only in case of "active commit", when the node being commited # job (only in case of "active commit", when the node being commited
# is used by the guest). The ability to complete is signaled with a # is used by the guest). The ability to complete is signaled with a
# BLOCK_JOB_READY event. # BLOCK_JOB_READY event.
# #
# This command completes an active background block operation # This command completes an active background block operation
@ -3068,10 +3068,10 @@
# #
# Deletes a job that is in the CONCLUDED state. This command only # Deletes a job that is in the CONCLUDED state. This command only
# needs to be run explicitly for jobs that don't have automatic # needs to be run explicitly for jobs that don't have automatic
# dismiss enabled. In turn, automatic dismiss may be enabled only # dismiss enabled. In turn, automatic dismiss may be enabled only
# for jobs that have @auto-dismiss option, which are drive-backup, # for jobs that have @auto-dismiss option, which are drive-backup,
# blockdev-backup, drive-mirror, blockdev-mirror, block-commit and # blockdev-backup, drive-mirror, blockdev-mirror, block-commit and
# block-stream. @auto-dismiss is enabled by default for these # block-stream. @auto-dismiss is enabled by default for these
# jobs. # jobs.
# #
# This command will refuse to operate on any job that has not yet # This command will refuse to operate on any job that has not yet
@ -4737,7 +4737,7 @@
# @active: whether the block node should be activated (default: true). # @active: whether the block node should be activated (default: true).
# Having inactive block nodes is useful primarily for migration because it # Having inactive block nodes is useful primarily for migration because it
# allows opening an image on the destination while the source is still # allows opening an image on the destination while the source is still
# holding locks for it. (Since 10.0) # holding locks for it. (Since 10.0)
# #
# @read-only: whether the block device should be read-only (default: # @read-only: whether the block device should be read-only (default:
# false). Note that some block drivers support only read-only # false). Note that some block drivers support only read-only
@ -4999,14 +4999,14 @@
## ##
# @blockdev-set-active: # @blockdev-set-active:
# #
# Activate or inactivate a block device. Use this to manage the handover of # Activate or inactivate a block device. Use this to manage the handover of
# block devices on migration with qemu-storage-daemon. # block devices on migration with qemu-storage-daemon.
# #
# Activating a node automatically activates all of its child nodes first. # Activating a node automatically activates all of its child nodes first.
# Inactivating a node automatically inactivates any of its child nodes that are # Inactivating a node automatically inactivates any of its child nodes that are
# not in use by a still active node. # not in use by a still active node.
# #
# @node-name: Name of the graph node to activate or inactivate. By default, all # @node-name: Name of the graph node to activate or inactivate. By default, all
# nodes are affected by the operation. # nodes are affected by the operation.
# #
# @active: true if the nodes should be active when the command returns success, # @active: true if the nodes should be active when the command returns success,

4
qapi/block-export.json
View file

@ -373,9 +373,9 @@
# (since: 5.2) # (since: 5.2)
# #
# @allow-inactive: If true, the export allows the exported node to be inactive. # @allow-inactive: If true, the export allows the exported node to be inactive.
# If it is created for an inactive block node, the node remains inactive. If # If it is created for an inactive block node, the node remains inactive. If
# the export type doesn't support running on an inactive node, an error is # the export type doesn't support running on an inactive node, an error is
# returned. If false, inactive block nodes are automatically activated before # returned. If false, inactive block nodes are automatically activated before
# creating the export and trying to inactivate them later fails. # creating the export and trying to inactivate them later fails.
# (since: 10.0; default: false) # (since: 10.0; default: false)
# #

2
qapi/char.json
View file

@ -274,7 +274,7 @@
# @reconnect: For a client socket, if a socket is disconnected, then # @reconnect: For a client socket, if a socket is disconnected, then
# attempt a reconnect after the given number of seconds. Setting # attempt a reconnect after the given number of seconds. Setting
# this to zero disables this function. The use of this member is # this to zero disables this function. The use of this member is
# deprecated, use @reconnect-ms instead. (default: 0) (Since: 2.2) # deprecated, use @reconnect-ms instead. (default: 0) (Since: 2.2)
# #
# @reconnect-ms: For a client socket, if a socket is disconnected, # @reconnect-ms: For a client socket, if a socket is disconnected,
# then attempt a reconnect after the given number of milliseconds. # then attempt a reconnect after the given number of milliseconds.

3
qapi/crypto.json
View file

@ -55,7 +55,8 @@
# @sha512: SHA-512. (since 2.7) # @sha512: SHA-512. (since 2.7)
# #
# @ripemd160: RIPEMD-160. (since 2.7) # @ripemd160: RIPEMD-160. (since 2.7)
# @sm3: SM3. (since 9.2.0) #
# @sm3: SM3. (since 9.2.0)
# #
# Since: 2.6 # Since: 2.6
## ##

8
qapi/job.json
View file

@ -191,10 +191,10 @@
# state. Completing the job in any other state is an error. # state. Completing the job in any other state is an error.
# #
# This is supported only for drive mirroring, where it also switches # This is supported only for drive mirroring, where it also switches
# the device to write to the target path only. Note that drive # the device to write to the target path only. Note that drive
# mirroring includes drive-mirror, blockdev-mirror and block-commit # mirroring includes drive-mirror, blockdev-mirror and block-commit
# job (only in case of "active commit", when the node being commited # job (only in case of "active commit", when the node being commited
# is used by the guest). The ability to complete is signaled with a # is used by the guest). The ability to complete is signaled with a
# BLOCK_JOB_READY event. # BLOCK_JOB_READY event.
# #
# This command completes an active background block operation # This command completes an active background block operation
@ -216,10 +216,10 @@
# #
# Deletes a job that is in the CONCLUDED state. This command only # Deletes a job that is in the CONCLUDED state. This command only
# needs to be run explicitly for jobs that don't have automatic # needs to be run explicitly for jobs that don't have automatic
# dismiss enabled. In turn, automatic dismiss may be enabled only # dismiss enabled. In turn, automatic dismiss may be enabled only
# for jobs that have @auto-dismiss option, which are drive-backup, # for jobs that have @auto-dismiss option, which are drive-backup,
# blockdev-backup, drive-mirror, blockdev-mirror, block-commit and # blockdev-backup, drive-mirror, blockdev-mirror, block-commit and
# block-stream. @auto-dismiss is enabled by default for these # block-stream. @auto-dismiss is enabled by default for these
# jobs. # jobs.
# #
# This command will refuse to operate on any job that has not yet # This command will refuse to operate on any job that has not yet

2
qapi/machine.json
View file

@ -694,7 +694,7 @@
# Structure of HMAT (Heterogeneous Memory Attribute Table) # Structure of HMAT (Heterogeneous Memory Attribute Table)
# #
# For more information about @HmatLBDataType, see chapter 5.2.27.4: # For more information about @HmatLBDataType, see chapter 5.2.27.4:
# Table 5-146: Field "Data Type" of ACPI 6.3 spec. # Table 5-146: Field "Data Type" of ACPI 6.3 spec.
# #
# @access-latency: access latency (nanoseconds) # @access-latency: access latency (nanoseconds)
# #

12
qapi/migration.json
View file

@ -842,9 +842,9 @@
# more CPU. Defaults to 1. (Since 5.0) # more CPU. Defaults to 1. (Since 5.0)
# #
# @multifd-qatzip-level: Set the compression level to be used in live # @multifd-qatzip-level: Set the compression level to be used in live
# migration. The level is an integer between 1 and 9, where 1 means # migration. The level is an integer between 1 and 9, where 1 means
# the best compression speed, and 9 means the best compression # the best compression speed, and 9 means the best compression
# ratio which will consume more CPU. Defaults to 1. (Since 9.2) # ratio which will consume more CPU. Defaults to 1. (Since 9.2)
# #
# @multifd-zstd-level: Set the compression level to be used in live # @multifd-zstd-level: Set the compression level to be used in live
# migration, the compression level is an integer between 0 and 20, # migration, the compression level is an integer between 0 and 20,
@ -1023,9 +1023,9 @@
# more CPU. Defaults to 1. (Since 5.0) # more CPU. Defaults to 1. (Since 5.0)
# #
# @multifd-qatzip-level: Set the compression level to be used in live # @multifd-qatzip-level: Set the compression level to be used in live
# migration. The level is an integer between 1 and 9, where 1 means # migration. The level is an integer between 1 and 9, where 1 means
# the best compression speed, and 9 means the best compression # the best compression speed, and 9 means the best compression
# ratio which will consume more CPU. Defaults to 1. (Since 9.2) # ratio which will consume more CPU. Defaults to 1. (Since 9.2)
# #
# @multifd-zstd-level: Set the compression level to be used in live # @multifd-zstd-level: Set the compression level to be used in live
# migration, the compression level is an integer between 0 and 20, # migration, the compression level is an integer between 0 and 20,
@ -1233,9 +1233,9 @@
# more CPU. Defaults to 1. (Since 5.0) # more CPU. Defaults to 1. (Since 5.0)
# #
# @multifd-qatzip-level: Set the compression level to be used in live # @multifd-qatzip-level: Set the compression level to be used in live
# migration. The level is an integer between 1 and 9, where 1 means # migration. The level is an integer between 1 and 9, where 1 means
# the best compression speed, and 9 means the best compression # the best compression speed, and 9 means the best compression
# ratio which will consume more CPU. Defaults to 1. (Since 9.2) # ratio which will consume more CPU. Defaults to 1. (Since 9.2)
# #
# @multifd-zstd-level: Set the compression level to be used in live # @multifd-zstd-level: Set the compression level to be used in live
# migration, the compression level is an integer between 0 and 20, # migration, the compression level is an integer between 0 and 20,

2
qapi/qom.json
View file

@ -870,7 +870,7 @@
# information read from devices and switches in conjunction with # information read from devices and switches in conjunction with
# link characteristics read from PCIe Configuration space. # link characteristics read from PCIe Configuration space.
# To get the full path latency from CPU to CXL attached DRAM # To get the full path latency from CPU to CXL attached DRAM
# CXL device: Add the latency from CPU to Generic Port (from # CXL device: Add the latency from CPU to Generic Port (from
# HMAT indexed via the node ID in this SRAT structure) to # HMAT indexed via the node ID in this SRAT structure) to
# that for CXL bus links, the latency across intermediate switches # that for CXL bus links, the latency across intermediate switches
# and from the EP port to the actual memory. Bandwidth is more # and from the EP port to the actual memory. Bandwidth is more