mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-08-28 20:41:52 -06:00
qapi: Tidy up run-together sentences in doc comments
Fixes: a937b6aa73
(qapi: Reformat doc comments to conform to current conventions)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250527073916.1243024-2-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
parent
6322b753f7
commit
5e203f73c2
5 changed files with 28 additions and 28 deletions
|
@ -80,7 +80,7 @@
|
||||||
##
|
##
|
||||||
# @ACPIOSTInfo:
|
# @ACPIOSTInfo:
|
||||||
#
|
#
|
||||||
# OSPM Status Indication for a device For description of possible
|
# OSPM Status Indication for a device. For description of possible
|
||||||
# values of @source and @status fields see "_OST (OSPM Status
|
# values of @source and @status fields see "_OST (OSPM Status
|
||||||
# Indication)" chapter of ACPI5.0 spec.
|
# Indication)" chapter of ACPI5.0 spec.
|
||||||
#
|
#
|
||||||
|
|
|
@ -2667,7 +2667,7 @@
|
||||||
# @iops-total-max: I/O operations burst
|
# @iops-total-max: I/O operations burst
|
||||||
#
|
#
|
||||||
# @iops-total-max-length: length of the iops-total-max burst period,
|
# @iops-total-max-length: length of the iops-total-max burst period,
|
||||||
# in seconds It must only be set if @iops-total-max is set as
|
# in seconds. It must only be set if @iops-total-max is set as
|
||||||
# well.
|
# well.
|
||||||
#
|
#
|
||||||
# @iops-read: limit read operations per second
|
# @iops-read: limit read operations per second
|
||||||
|
@ -2675,14 +2675,14 @@
|
||||||
# @iops-read-max: I/O operations read burst
|
# @iops-read-max: I/O operations read burst
|
||||||
#
|
#
|
||||||
# @iops-read-max-length: length of the iops-read-max burst period, in
|
# @iops-read-max-length: length of the iops-read-max burst period, in
|
||||||
# seconds It must only be set if @iops-read-max is set as well.
|
# seconds. It must only be set if @iops-read-max is set as well.
|
||||||
#
|
#
|
||||||
# @iops-write: limit write operations per second
|
# @iops-write: limit write operations per second
|
||||||
#
|
#
|
||||||
# @iops-write-max: I/O operations write burst
|
# @iops-write-max: I/O operations write burst
|
||||||
#
|
#
|
||||||
# @iops-write-max-length: length of the iops-write-max burst period,
|
# @iops-write-max-length: length of the iops-write-max burst period,
|
||||||
# in seconds It must only be set if @iops-write-max is set as
|
# in seconds. It must only be set if @iops-write-max is set as
|
||||||
# well.
|
# well.
|
||||||
#
|
#
|
||||||
# @bps-total: limit total bytes per second
|
# @bps-total: limit total bytes per second
|
||||||
|
@ -2697,14 +2697,14 @@
|
||||||
# @bps-read-max: total bytes read burst
|
# @bps-read-max: total bytes read burst
|
||||||
#
|
#
|
||||||
# @bps-read-max-length: length of the bps-read-max burst period, in
|
# @bps-read-max-length: length of the bps-read-max burst period, in
|
||||||
# seconds It must only be set if @bps-read-max is set as well.
|
# seconds. It must only be set if @bps-read-max is set as well.
|
||||||
#
|
#
|
||||||
# @bps-write: limit write bytes per second
|
# @bps-write: limit write bytes per second
|
||||||
#
|
#
|
||||||
# @bps-write-max: total bytes write burst
|
# @bps-write-max: total bytes write burst
|
||||||
#
|
#
|
||||||
# @bps-write-max-length: length of the bps-write-max burst period, in
|
# @bps-write-max-length: length of the bps-write-max burst period, in
|
||||||
# seconds It must only be set if @bps-write-max is set as well.
|
# seconds. It must only be set if @bps-write-max is set as well.
|
||||||
#
|
#
|
||||||
# @iops-size: when limiting by iops max size of an I/O in bytes
|
# @iops-size: when limiting by iops max size of an I/O in bytes
|
||||||
#
|
#
|
||||||
|
@ -5580,7 +5580,7 @@
|
||||||
# @x-blockdev-amend:
|
# @x-blockdev-amend:
|
||||||
#
|
#
|
||||||
# Starts a job to amend format specific options of an existing open
|
# Starts a job to amend format specific options of an existing open
|
||||||
# block device The job is automatically finalized, but a manual
|
# block device. The job is automatically finalized, but a manual
|
||||||
# job-dismiss is required.
|
# job-dismiss is required.
|
||||||
#
|
#
|
||||||
# @job-id: Identifier for the newly created job.
|
# @job-id: Identifier for the newly created job.
|
||||||
|
@ -5589,7 +5589,7 @@
|
||||||
#
|
#
|
||||||
# @options: Options (driver specific)
|
# @options: Options (driver specific)
|
||||||
#
|
#
|
||||||
# @force: Allow unsafe operations, format specific For luks that
|
# @force: Allow unsafe operations, format specific. For luks that
|
||||||
# allows erase of the last active keyslot (permanent loss of
|
# allows erase of the last active keyslot (permanent loss of
|
||||||
# data), and replacement of an active keyslot (possible loss of
|
# data), and replacement of an active keyslot (possible loss of
|
||||||
# data if IO error happens)
|
# data if IO error happens)
|
||||||
|
|
|
@ -202,19 +202,19 @@
|
||||||
#
|
#
|
||||||
# The options that apply to LUKS encryption format initialization
|
# The options that apply to LUKS encryption format initialization
|
||||||
#
|
#
|
||||||
# @cipher-alg: the cipher algorithm for data encryption Currently
|
# @cipher-alg: the cipher algorithm for data encryption. Currently
|
||||||
# defaults to 'aes-256'.
|
# defaults to 'aes-256'.
|
||||||
#
|
#
|
||||||
# @cipher-mode: the cipher mode for data encryption Currently defaults
|
# @cipher-mode: the cipher mode for data encryption. Currently
|
||||||
# to 'xts'
|
# defaults to 'xts'
|
||||||
#
|
#
|
||||||
# @ivgen-alg: the initialization vector generator Currently defaults
|
# @ivgen-alg: the initialization vector generator. Currently defaults
|
||||||
# to 'plain64'
|
# to 'plain64'
|
||||||
#
|
#
|
||||||
# @ivgen-hash-alg: the initialization vector generator hash Currently
|
# @ivgen-hash-alg: the initialization vector generator hash.
|
||||||
# defaults to 'sha256'
|
# Currently defaults to 'sha256'
|
||||||
#
|
#
|
||||||
# @hash-alg: the master key hash algorithm Currently defaults to
|
# @hash-alg: the master key hash algorithm. Currently defaults to
|
||||||
# 'sha256'
|
# 'sha256'
|
||||||
#
|
#
|
||||||
# @iter-time: number of milliseconds to spend in PBKDF passphrase
|
# @iter-time: number of milliseconds to spend in PBKDF passphrase
|
||||||
|
@ -370,11 +370,11 @@
|
||||||
# @new-secret: The ID of a QCryptoSecret object providing the password
|
# @new-secret: The ID of a QCryptoSecret object providing the password
|
||||||
# to be written into added active keyslots
|
# to be written into added active keyslots
|
||||||
#
|
#
|
||||||
# @old-secret: Optional (for deactivation only) If given will
|
# @old-secret: Optional (for deactivation only). If given will
|
||||||
# deactivate all keyslots that match password located in
|
# deactivate all keyslots that match password located in
|
||||||
# QCryptoSecret with this ID
|
# QCryptoSecret with this ID
|
||||||
#
|
#
|
||||||
# @iter-time: Optional (for activation only) Number of milliseconds to
|
# @iter-time: Optional (for activation only). Number of milliseconds to
|
||||||
# spend in PBKDF passphrase processing for the newly activated
|
# spend in PBKDF passphrase processing for the newly activated
|
||||||
# keyslot. Currently defaults to 2000.
|
# keyslot. Currently defaults to 2000.
|
||||||
#
|
#
|
||||||
|
|
|
@ -1160,7 +1160,7 @@
|
||||||
#
|
#
|
||||||
# Information about the guest balloon device.
|
# Information about the guest balloon device.
|
||||||
#
|
#
|
||||||
# @actual: the logical size of the VM in bytes Formula used:
|
# @actual: the logical size of the VM in bytes. Formula used:
|
||||||
# logical_vm_size = vm_ram_size - balloon_size
|
# logical_vm_size = vm_ram_size - balloon_size
|
||||||
#
|
#
|
||||||
# Since: 0.14
|
# Since: 0.14
|
||||||
|
@ -1199,7 +1199,7 @@
|
||||||
# is equivalent to the @actual field return by the 'query-balloon'
|
# is equivalent to the @actual field return by the 'query-balloon'
|
||||||
# command
|
# command
|
||||||
#
|
#
|
||||||
# @actual: the logical size of the VM in bytes Formula used:
|
# @actual: the logical size of the VM in bytes. Formula used:
|
||||||
# logical_vm_size = vm_ram_size - balloon_size
|
# logical_vm_size = vm_ram_size - balloon_size
|
||||||
#
|
#
|
||||||
# .. note:: This event is rate-limited.
|
# .. note:: This event is rate-limited.
|
||||||
|
|
|
@ -760,9 +760,9 @@
|
||||||
# auto-converge detects that migration is not making progress.
|
# auto-converge detects that migration is not making progress.
|
||||||
# The default value is 10. (Since 2.7)
|
# The default value is 10. (Since 2.7)
|
||||||
#
|
#
|
||||||
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage At
|
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
|
||||||
# the tail stage of throttling, the Guest is very sensitive to CPU
|
# At the tail stage of throttling, the Guest is very sensitive to
|
||||||
# percentage while the @cpu-throttle -increment is excessive
|
# CPU percentage while the @cpu-throttle -increment is excessive
|
||||||
# usually at tail stage. If this parameter is true, we will
|
# usually at tail stage. If this parameter is true, we will
|
||||||
# compute the ideal CPU percentage used by the Guest, which may
|
# compute the ideal CPU percentage used by the Guest, which may
|
||||||
# exactly make the dirty rate match the dirty rate threshold.
|
# exactly make the dirty rate match the dirty rate threshold.
|
||||||
|
@ -941,9 +941,9 @@
|
||||||
# auto-converge detects that migration is not making progress.
|
# auto-converge detects that migration is not making progress.
|
||||||
# The default value is 10. (Since 2.7)
|
# The default value is 10. (Since 2.7)
|
||||||
#
|
#
|
||||||
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage At
|
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
|
||||||
# the tail stage of throttling, the Guest is very sensitive to CPU
|
# At the tail stage of throttling, the Guest is very sensitive to
|
||||||
# percentage while the @cpu-throttle -increment is excessive
|
# CPU percentage while the @cpu-throttle -increment is excessive
|
||||||
# usually at tail stage. If this parameter is true, we will
|
# usually at tail stage. If this parameter is true, we will
|
||||||
# compute the ideal CPU percentage used by the Guest, which may
|
# compute the ideal CPU percentage used by the Guest, which may
|
||||||
# exactly make the dirty rate match the dirty rate threshold.
|
# exactly make the dirty rate match the dirty rate threshold.
|
||||||
|
@ -1155,9 +1155,9 @@
|
||||||
# auto-converge detects that migration is not making progress.
|
# auto-converge detects that migration is not making progress.
|
||||||
# (Since 2.7)
|
# (Since 2.7)
|
||||||
#
|
#
|
||||||
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage At
|
# @cpu-throttle-tailslow: Make CPU throttling slower at tail stage.
|
||||||
# the tail stage of throttling, the Guest is very sensitive to CPU
|
# At the tail stage of throttling, the Guest is very sensitive to
|
||||||
# percentage while the @cpu-throttle -increment is excessive
|
# CPU percentage while the @cpu-throttle -increment is excessive
|
||||||
# usually at tail stage. If this parameter is true, we will
|
# usually at tail stage. If this parameter is true, we will
|
||||||
# compute the ideal CPU percentage used by the Guest, which may
|
# compute the ideal CPU percentage used by the Guest, which may
|
||||||
# exactly make the dirty rate match the dirty rate threshold.
|
# exactly make the dirty rate match the dirty rate threshold.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue