Skip to content

Commit

Permalink
qapi: Correct documentation indentation and whitespace
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240322140910.328840-12-armbru@redhat.com>
[Add a previous patch's stray hunk]
  • Loading branch information
Markus Armbruster committed Mar 26, 2024
1 parent 209e64d commit 5305a4e
Show file tree
Hide file tree
Showing 10 changed files with 51 additions and 56 deletions.
20 changes: 10 additions & 10 deletions qapi/block-core.json
Original file line number Diff line number Diff line change
Expand Up @@ -2593,27 +2593,27 @@
#
# @bps_max_length: maximum length of the @bps_max burst period, in
# seconds. It must only be set if @bps_max is set as well.
# Defaults to 1. (Since 2.6)
# Defaults to 1. (Since 2.6)
#
# @bps_rd_max_length: maximum length of the @bps_rd_max burst period,
# in seconds. It must only be set if @bps_rd_max is set as well.
# Defaults to 1. (Since 2.6)
# Defaults to 1. (Since 2.6)
#
# @bps_wr_max_length: maximum length of the @bps_wr_max burst period,
# in seconds. It must only be set if @bps_wr_max is set as well.
# Defaults to 1. (Since 2.6)
# Defaults to 1. (Since 2.6)
#
# @iops_max_length: maximum length of the @iops burst period, in
# seconds. It must only be set if @iops_max is set as well.
# Defaults to 1. (Since 2.6)
# Defaults to 1. (Since 2.6)
#
# @iops_rd_max_length: maximum length of the @iops_rd_max burst
# period, in seconds. It must only be set if @iops_rd_max is set
# as well. Defaults to 1. (Since 2.6)
# as well. Defaults to 1. (Since 2.6)
#
# @iops_wr_max_length: maximum length of the @iops_wr_max burst
# period, in seconds. It must only be set if @iops_wr_max is set
# as well. Defaults to 1. (Since 2.6)
# as well. Defaults to 1. (Since 2.6)
#
# @iops_size: an I/O size in bytes (Since 1.7)
#
Expand Down Expand Up @@ -3354,7 +3354,7 @@
# decryption key (since 2.6). Mandatory except when doing a
# metadata-only probe of the image.
#
# @header: block device holding a detached LUKS header. (since 9.0)
# @header: block device holding a detached LUKS header. (since 9.0)
#
# Since: 2.9
##
Expand Down Expand Up @@ -4619,7 +4619,7 @@
# seconds for copy-before-write operation. When a timeout occurs,
# the respective copy-before-write operation will fail, and the
# @on-cbw-error parameter will decide how this failure is handled.
# Default 0. (Since 7.1)
# Default 0. (Since 7.1)
#
# Since: 6.2
##
Expand Down Expand Up @@ -4953,9 +4953,9 @@
# Driver specific image creation options for LUKS.
#
# @file: Node to create the image format on, mandatory except when
# 'preallocation' is not requested
# 'preallocation' is not requested
#
# @header: Block device holding a detached LUKS header. (since 9.0)
# @header: Block device holding a detached LUKS header. (since 9.0)
#
# @size: Size of the virtual disk in bytes
#
Expand Down
12 changes: 6 additions & 6 deletions qapi/crypto.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@
#
# @sha1: SHA-1. Should not be used in any new code, legacy compat only
#
# @sha224: SHA-224. (since 2.7)
# @sha224: SHA-224. (since 2.7)
#
# @sha256: SHA-256. Current recommended strong hash.
#
# @sha384: SHA-384. (since 2.7)
# @sha384: SHA-384. (since 2.7)
#
# @sha512: SHA-512. (since 2.7)
# @sha512: SHA-512. (since 2.7)
#
# @ripemd160: RIPEMD-160. (since 2.7)
# @ripemd160: RIPEMD-160. (since 2.7)
#
# Since: 2.6
##
Expand Down Expand Up @@ -224,9 +224,9 @@
# 'sha256'
#
# @iter-time: number of milliseconds to spend in PBKDF passphrase
# processing. Currently defaults to 2000. (since 2.8)
# processing. Currently defaults to 2000. (since 2.8)
#
# @detached-header: create a detached LUKS header. (since 9.0)
# @detached-header: create a detached LUKS header. (since 9.0)
#
# Since: 2.6
##
Expand Down
2 changes: 1 addition & 1 deletion qapi/dump.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
#
# @detach: if true, QMP will return immediately rather than waiting
# for the dump to finish. The user can track progress using
# "query-dump". (since 2.6).
# "query-dump". (since 2.6).
#
# @begin: if specified, the starting physical address.
#
Expand Down
3 changes: 1 addition & 2 deletions qapi/machine.json
Original file line number Diff line number Diff line change
Expand Up @@ -920,7 +920,7 @@
# @socket-id: socket number within parent container the CPU belongs to
#
# @die-id: die number within the parent container the CPU belongs to
# (since 4.1)
# (since 4.1)
#
# @cluster-id: cluster number within the parent container the CPU
# belongs to (since 7.1)
Expand Down Expand Up @@ -1190,7 +1190,6 @@
# <- { "event": "HV_BALLOON_STATUS_REPORT",
# "data": { "committed": 816640000, "available": 3333054464 },
# "timestamp": { "seconds": 1600295492, "microseconds": 661044 } }
#
##
{ 'event': 'HV_BALLOON_STATUS_REPORT',
'data': 'HvBalloonInfo' }
Expand Down
38 changes: 18 additions & 20 deletions qapi/migration.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@
# @deprecated: Member @skipped is always zero since 1.5.3
#
# Since: 0.14
#
##
{ 'struct': 'MigrationStats',
'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
Expand Down Expand Up @@ -230,7 +229,7 @@
# throttled during auto-converge. This is only present when
# auto-converge has started throttling guest cpus. (Since 2.7)
#
# @error-desc: the human readable error description string. Clients
# @error-desc: the human readable error description string. Clients
# should not attempt to parse the error strings. (Since 2.7)
#
# @postcopy-blocktime: total time when all vCPU were blocked during
Expand Down Expand Up @@ -638,7 +637,7 @@
##
# @MigMode:
#
# @normal: the original form of migration. (since 8.2)
# @normal: the original form of migration. (since 8.2)
#
# @cpr-reboot: The migrate command stops the VM and saves state to the
# URI. After quitting QEMU, the user resumes by running QEMU
Expand Down Expand Up @@ -781,15 +780,15 @@
#
# @throttle-trigger-threshold: The ratio of bytes_dirty_period and
# bytes_xfer_period to trigger throttling. It is expressed as
# percentage. The default value is 50. (Since 5.0)
# percentage. The default value is 50. (Since 5.0)
#
# @cpu-throttle-initial: Initial percentage of time guest cpus are
# throttled when migration auto-converge is activated. The
# default value is 20. (Since 2.7)
# default value is 20. (Since 2.7)
#
# @cpu-throttle-increment: throttle percentage increase each time
# 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
# the tail stage of throttling, the Guest is very sensitive to CPU
Expand Down Expand Up @@ -877,13 +876,13 @@
# migration, the compression level is an integer between 0 and 9,
# where 0 means no compression, 1 means the best compression
# speed, and 9 means best compression ratio which will consume
# more CPU. Defaults to 1. (Since 5.0)
# more CPU. Defaults to 1. (Since 5.0)
#
# @multifd-zstd-level: Set the compression level to be used in live
# migration, the compression level is an integer between 0 and 20,
# where 0 means no compression, 1 means the best compression
# speed, and 20 means best compression ratio which will consume
# more CPU. Defaults to 1. (Since 5.0)
# more CPU. Defaults to 1. (Since 5.0)
#
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
# aliases for the purpose of dirty bitmap migration. Such aliases
Expand Down Expand Up @@ -989,15 +988,15 @@
#
# @throttle-trigger-threshold: The ratio of bytes_dirty_period and
# bytes_xfer_period to trigger throttling. It is expressed as
# percentage. The default value is 50. (Since 5.0)
# percentage. The default value is 50. (Since 5.0)
#
# @cpu-throttle-initial: Initial percentage of time guest cpus are
# throttled when migration auto-converge is activated. The
# default value is 20. (Since 2.7)
# default value is 20. (Since 2.7)
#
# @cpu-throttle-increment: throttle percentage increase each time
# 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
# the tail stage of throttling, the Guest is very sensitive to CPU
Expand Down Expand Up @@ -1085,13 +1084,13 @@
# migration, the compression level is an integer between 0 and 9,
# where 0 means no compression, 1 means the best compression
# speed, and 9 means best compression ratio which will consume
# more CPU. Defaults to 1. (Since 5.0)
# more CPU. Defaults to 1. (Since 5.0)
#
# @multifd-zstd-level: Set the compression level to be used in live
# migration, the compression level is an integer between 0 and 20,
# where 0 means no compression, 1 means the best compression
# speed, and 20 means best compression ratio which will consume
# more CPU. Defaults to 1. (Since 5.0)
# more CPU. Defaults to 1. (Since 5.0)
#
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
# aliases for the purpose of dirty bitmap migration. Such aliases
Expand Down Expand Up @@ -1225,7 +1224,7 @@
#
# @throttle-trigger-threshold: The ratio of bytes_dirty_period and
# bytes_xfer_period to trigger throttling. It is expressed as
# percentage. The default value is 50. (Since 5.0)
# percentage. The default value is 50. (Since 5.0)
#
# @cpu-throttle-initial: Initial percentage of time guest cpus are
# throttled when migration auto-converge is activated. (Since
Expand Down Expand Up @@ -1317,13 +1316,13 @@
# migration, the compression level is an integer between 0 and 9,
# where 0 means no compression, 1 means the best compression
# speed, and 9 means best compression ratio which will consume
# more CPU. Defaults to 1. (Since 5.0)
# more CPU. Defaults to 1. (Since 5.0)
#
# @multifd-zstd-level: Set the compression level to be used in live
# migration, the compression level is an integer between 0 and 20,
# where 0 means no compression, 1 means the best compression
# speed, and 20 means best compression ratio which will consume
# more CPU. Defaults to 1. (Since 5.0)
# more CPU. Defaults to 1. (Since 5.0)
#
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
# aliases for the purpose of dirty bitmap migration. Such aliases
Expand Down Expand Up @@ -1750,7 +1749,7 @@
# @detach: this argument exists only for compatibility reasons and is
# ignored by QEMU
#
# @resume: resume one paused migration, default "off". (since 3.0)
# @resume: resume one paused migration, default "off". (since 3.0)
#
# Features:
#
Expand Down Expand Up @@ -2176,7 +2175,6 @@
# @millisecond: value is in milliseconds
#
# Since: 8.2
#
##
{ 'enum': 'TimeUnit',
'data': ['second', 'millisecond'] }
Expand Down Expand Up @@ -2258,7 +2256,7 @@
# 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)
# 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
Expand Down Expand Up @@ -2295,7 +2293,7 @@
# Query results of the most recent invocation of @calc-dirty-rate.
#
# @calc-time-unit: time unit in which to report calculation time.
# By default it is reported in seconds. (Since 8.2)
# By default it is reported in seconds. (Since 8.2)
#
# Since: 5.2
#
Expand Down
2 changes: 1 addition & 1 deletion qapi/misc.json
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
# 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)
# cause a transition to the "paused" state. (Since 9.0)
#
# Example:
#
Expand Down
4 changes: 2 additions & 2 deletions qapi/qom.json
Original file line number Diff line number Diff line change
Expand Up @@ -649,14 +649,14 @@
#
# @offset: the offset into the target file that the region starts at.
# You can use this option to back multiple regions with a single
# file. Must be a multiple of the page size.
# file. Must be a multiple of the page size.
# (default: 0) (since 8.1)
#
# @discard-data: if true, the file contents can be destroyed when QEMU
# exits, to avoid unnecessarily flushing data to the backing file.
# Note that @discard-data is only an optimization, and QEMU might
# not discard file contents if it aborts unexpectedly or is
# terminated using SIGKILL. (default: false)
# terminated using SIGKILL. (default: false)
#
# @mem-path: the path to either a shared memory or huge page
# filesystem mount
Expand Down
9 changes: 4 additions & 5 deletions qapi/run-state.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
#
# @snapshot-load: A snapshot is being loaded by the record & replay
# subsystem. This value is used only within QEMU. It doesn't
# occur in QMP. (since 7.2)
# occur in QMP. (since 7.2)
##
{ 'enum': 'ShutdownCause',
# Beware, shutdown_caused_by_guest() depends on enumeration order
Expand All @@ -109,7 +109,6 @@
# @status: the virtual machine @RunState
#
# Since: 0.14
#
##
{ 'struct': 'StatusInfo',
'data': {'running': 'bool',
Expand Down Expand Up @@ -142,7 +141,7 @@
# @guest: If true, the shutdown was triggered by a guest request (such
# as a guest-initiated ACPI shutdown request or other
# hardware-specific action) rather than a host request (such as
# sending qemu a SIGINT). (since 2.10)
# sending qemu a SIGINT). (since 2.10)
#
# @reason: The @ShutdownCause which resulted in the SHUTDOWN.
# (since 4.0)
Expand Down Expand Up @@ -184,9 +183,9 @@
# @guest: If true, the reset was triggered by a guest request (such as
# a guest-initiated ACPI reboot request or other hardware-specific
# action) rather than a host request (such as the QMP command
# system_reset). (since 2.10)
# system_reset). (since 2.10)
#
# @reason: The @ShutdownCause of the RESET. (since 4.0)
# @reason: The @ShutdownCause of the RESET. (since 4.0)
#
# Since: 0.12
#
Expand Down
3 changes: 1 addition & 2 deletions qapi/sockets.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
# @keep-alive: enable keep-alive when connecting to this socket. Not
# supported for passive sockets. (Since 4.2)
#
# @mptcp: enable multi-path TCP. (Since 6.1)
# @mptcp: enable multi-path TCP. (Since 6.1)
#
# Since: 1.3
##
Expand Down Expand Up @@ -125,7 +125,6 @@
# Decimal file descriptors are permitted at startup or other
# contexts where no monitor context is active.
#
#
# Since: 1.2
##
{ 'struct': 'FdSocketAddress',
Expand Down

0 comments on commit 5305a4e

Please sign in to comment.