diff options
| -rw-r--r-- | qapi/block-core.json | 85 | ||||
| -rw-r--r-- | qapi/block.json | 12 | ||||
| -rw-r--r-- | qapi/cxl.json | 4 | ||||
| -rw-r--r-- | qapi/machine-target.json | 2 | ||||
| -rw-r--r-- | qapi/migration.json | 10 | ||||
| -rw-r--r-- | qapi/net.json | 1 | ||||
| -rw-r--r-- | qapi/qdev.json | 6 | ||||
| -rw-r--r-- | qapi/qom.json | 9 | ||||
| -rw-r--r-- | qapi/trace.json | 9 | ||||
| -rw-r--r-- | qapi/ui.json | 2 |
10 files changed, 66 insertions, 74 deletions
diff --git a/qapi/block-core.json b/qapi/block-core.json index 5dd5f7e..2b1d493 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -136,7 +136,7 @@ # # @filename: Name of the extent file # -# @format: Extent type (e.g. FLAT or SPARSE) +# @format: Extent type (e.g. FLAT or SPARSE) # # @virtual-size: Number of bytes covered by this extent # @@ -652,10 +652,9 @@ # 10), [10, 50), [50, 100), [100, +inf). # # @bins: list of io request counts corresponding to histogram -# intervals. -# len(@bins) = len(@boundaries) + 1 -# For the example above, @bins may be something like [3, 1, 5, 2], -# and corresponding histogram looks like: +# intervals, one more element than @boundaries has. For the +# example above, @bins may be something like [3, 1, 5, 2], and +# corresponding histogram looks like: # # :: # @@ -854,9 +853,8 @@ # @min_wr_latency_ns: Minimum latency of write operations in the # defined interval, in nanoseconds. # -# @min_zone_append_latency_ns: Minimum latency of zone append operations -# in the defined interval, in nanoseconds -# (since 8.1) +# @min_zone_append_latency_ns: Minimum latency of zone append +# operations in the defined interval, in nanoseconds (since 8.1) # # @min_flush_latency_ns: Minimum latency of flush operations in the # defined interval, in nanoseconds. @@ -867,9 +865,8 @@ # @max_wr_latency_ns: Maximum latency of write operations in the # defined interval, in nanoseconds. # -# @max_zone_append_latency_ns: Maximum latency of zone append operations -# in the defined interval, in nanoseconds -# (since 8.1) +# @max_zone_append_latency_ns: Maximum latency of zone append +# operations in the defined interval, in nanoseconds (since 8.1) # # @max_flush_latency_ns: Maximum latency of flush operations in the # defined interval, in nanoseconds. @@ -880,9 +877,8 @@ # @avg_wr_latency_ns: Average latency of write operations in the # defined interval, in nanoseconds. # -# @avg_zone_append_latency_ns: Average latency of zone append operations -# in the defined interval, in nanoseconds -# (since 8.1) +# @avg_zone_append_latency_ns: Average latency of zone append +# operations in the defined interval, in nanoseconds (since 8.1) # # @avg_flush_latency_ns: Average latency of flush operations in the # defined interval, in nanoseconds. @@ -894,8 +890,7 @@ # the defined interval. # # @avg_zone_append_queue_depth: Average number of pending zone append -# operations in the defined interval -# (since 8.1). +# operations in the defined interval (since 8.1). # # Since: 2.5 ## @@ -920,8 +915,8 @@ # # @wr_bytes: The number of bytes written by the device. # -# @zone_append_bytes: The number of bytes appended by the zoned devices -# (since 8.1) +# @zone_append_bytes: The number of bytes appended by the zoned +# devices (since 8.1) # # @unmap_bytes: The number of bytes unmapped by the device (Since 4.2) # @@ -931,8 +926,8 @@ # @wr_operations: The number of write operations performed by the # device. # -# @zone_append_operations: The number of zone append operations performed -# by the zoned devices (since 8.1) +# @zone_append_operations: The number of zone append operations +# performed by the zoned devices (since 8.1) # # @flush_operations: The number of cache flush operations performed by # the device (since 0.15) @@ -947,7 +942,7 @@ # 0.15). # # @zone_append_total_time_ns: Total time spent on zone append writes -# in nanoseconds (since 8.1) +# in nanoseconds (since 8.1) # # @flush_total_time_ns: Total time spent on cache flushes in # nanoseconds (since 0.15). @@ -966,8 +961,8 @@ # @wr_merged: Number of write requests that have been merged into # another request (Since 2.3). # -# @zone_append_merged: Number of zone append requests that have been merged -# into another request (since 8.1) +# @zone_append_merged: Number of zone append requests that have been +# merged into another request (since 8.1) # # @unmap_merged: Number of unmap requests that have been merged into # another request (Since 4.2) @@ -982,9 +977,8 @@ # @failed_wr_operations: The number of failed write operations # performed by the device (Since 2.5) # -# @failed_zone_append_operations: The number of failed zone append write -# operations performed by the zoned devices -# (since 8.1) +# @failed_zone_append_operations: The number of failed zone append +# write operations performed by the zoned devices (since 8.1) # # @failed_flush_operations: The number of failed flush operations # performed by the device (Since 2.5) @@ -998,8 +992,8 @@ # @invalid_wr_operations: The number of invalid write operations # performed by the device (Since 2.5) # -# @invalid_zone_append_operations: The number of invalid zone append operations -# performed by the zoned device (since 8.1) +# @invalid_zone_append_operations: The number of invalid zone append +# operations performed by the zoned device (since 8.1) # # @invalid_flush_operations: The number of invalid flush operations # performed by the device (Since 2.5) @@ -1020,7 +1014,8 @@ # # @wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) # -# @zone_append_latency_histogram: @BlockLatencyHistogramInfo. (since 8.1) +# @zone_append_latency_histogram: @BlockLatencyHistogramInfo. +# (since 8.1) # # @flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) # @@ -1127,7 +1122,7 @@ # # @parent: This describes the file block device if it has one. # Contains recursively the statistics of the underlying protocol -# (e.g. the host file for a qcow2 image). If there is no +# (e.g. the host file for a qcow2 image). If there is no # underlying protocol, this field is omitted # # @backing: This describes the backing block device if it has one. @@ -1487,7 +1482,7 @@ # @format: the format of the overlay image, default is 'qcow2'. # # @mode: whether and how QEMU should create a new image, default is -# 'absolute-paths'. +# 'absolute-paths'. ## { 'struct': 'BlockdevSnapshotSync', 'data': { '*device': 'str', '*node-name': 'str', @@ -1551,7 +1546,7 @@ # # @bitmap: The name of a dirty bitmap to use. Must be present if sync # is "bitmap" or "incremental". Can be present if sync is "full" -# or "top". Must not be present otherwise. +# or "top". Must not be present otherwise. # (Since 2.4 (drive-backup), 3.1 (blockdev-backup)) # # @bitmap-mode: Specifies the type of data the bitmap should contain @@ -3478,16 +3473,16 @@ # @pass-discard-other: whether discard requests for the data source # should be issued on other occasions where a cluster gets freed # -# @discard-no-unref: when enabled, discards from the guest will not cause -# cluster allocations to be relinquished. This prevents qcow2 fragmentation -# that would be caused by such discards. Besides potential -# performance degradation, such fragmentation can lead to increased -# allocation of clusters past the end of the image file, -# resulting in image files whose file length can grow much larger -# than their guest disk size would suggest. -# If image file length is of concern (e.g. when storing qcow2 -# images directly on block devices), you should consider enabling -# this option. (since 8.1) +# @discard-no-unref: when enabled, discards from the guest will not +# cause cluster allocations to be relinquished. This prevents +# qcow2 fragmentation that would be caused by such discards. +# Besides potential performance degradation, such fragmentation +# can lead to increased allocation of clusters past the end of the +# image file, resulting in image files whose file length can grow +# much larger than their guest disk size would suggest. If image +# file length is of concern (e.g. when storing qcow2 images +# directly on block devices), you should consider enabling this +# option. (since 8.1) # # @overlap-check: which overlap checks to perform for writes to the # image, defaults to 'cached' (since 2.2) @@ -5241,9 +5236,9 @@ # # @subformat: vhdx subformat (default: dynamic) # -# @block-state-zero: Force use of payload blocks of type -# 'ZERO'. Non-standard, but default. Do not set to 'off' when -# using 'qemu-img convert' with subformat=dynamic. +# @block-state-zero: Force use of payload blocks of type 'ZERO'. +# Non-standard, but default. Do not set to 'off' when using +# 'qemu-img convert' with subformat=dynamic. # # Since: 2.12 ## diff --git a/qapi/block.json b/qapi/block.json index 0f25ce3..998008c 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -534,8 +534,8 @@ # @boundaries-write: list of interval boundary values for write # latency histogram. # -# @boundaries-zap: list of interval boundary values for zone append write -# latency histogram. +# @boundaries-zap: list of interval boundary values for zone append +# write latency histogram. # # @boundaries-flush: list of interval boundary values for flush # latency histogram. @@ -547,7 +547,7 @@ # # Example: # -# set new histograms for all io types with intervals [0, 10), [10, +# Set new histograms for all io types with intervals [0, 10), [10, # 50), [50, 100), [100, +inf): # # -> { "execute": "block-latency-histogram-set", @@ -557,7 +557,7 @@ # # Example: # -# set new histogram only for write, other histograms will remain not +# Set new histogram only for write, other histograms will remain not # changed (or not created): # # -> { "execute": "block-latency-histogram-set", @@ -567,7 +567,7 @@ # # Example: # -# set new histograms with the following intervals: read, flush: [0, +# Set new histograms with the following intervals: read, flush: [0, # 10), [10, 50), [50, 100), [100, +inf) write: [0, 1000), [1000, # 5000), [5000, +inf) # @@ -579,7 +579,7 @@ # # Example: # -# remove all latency histograms: +# Remove all latency histograms: # # -> { "execute": "block-latency-histogram-set", # "arguments": { "id": "drive0" } } diff --git a/qapi/cxl.json b/qapi/cxl.json index d5b5293..8cc4c72 100644 --- a/qapi/cxl.json +++ b/qapi/cxl.json @@ -172,8 +172,8 @@ # # @temperature: Device temperature in degrees Celsius. # -# @dirty-shutdown-count: Number of times the device has been unable -# to determine whether data loss may have occurred. +# @dirty-shutdown-count: Number of times the device has been unable to +# determine whether data loss may have occurred. # # @corrected-volatile-error-count: Total number of correctable errors # in volatile memory. diff --git a/qapi/machine-target.json b/qapi/machine-target.json index 3362f8d..f0a6b72 100644 --- a/qapi/machine-target.json +++ b/qapi/machine-target.json @@ -61,7 +61,7 @@ # @CpuModelCompareResult: # # An enumeration of CPU model comparison results. The result is -# usually calculated using e.g. CPU features or CPU generations. +# usually calculated using e.g. CPU features or CPU generations. # # @incompatible: If model A is incompatible to model B, model A is not # guaranteed to run where model B runs and the other way around. diff --git a/qapi/migration.json b/qapi/migration.json index 388425b..6b49593 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -487,8 +487,8 @@ # block devices (and thus take locks) immediately at the end of # migration. (since 3.0) # -# @x-ignore-shared: If enabled, QEMU will not migrate shared memory that is -# accessible on the destination machine. (since 4.0) +# @x-ignore-shared: If enabled, QEMU will not migrate shared memory +# that is accessible on the destination machine. (since 4.0) # # @validate-uuid: Send the UUID of the source to allow the destination # to ensure it is the same. (since 4.2) @@ -512,9 +512,9 @@ # @switchover-ack: If enabled, migration will not stop the source VM # and complete the migration until an ACK is received from the # destination that it's OK to do so. Exactly when this ACK is -# sent depends on the migrated devices that use this feature. -# For example, a device can use it to make sure some of its data -# is sent and loaded in the destination before doing switchover. +# sent depends on the migrated devices that use this feature. For +# example, a device can use it to make sure some of its data is +# sent and loaded in the destination before doing switchover. # This can reduce downtime if devices that support this capability # are present. 'return-path' capability must be enabled to use # it. (since 8.1) diff --git a/qapi/net.json b/qapi/net.json index db67501..313c8a6 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -663,7 +663,6 @@ # @type: Specify the driver used for interpreting remaining arguments. # # Since: 1.2 -# ## { 'union': 'Netdev', 'base': { 'id': 'str', 'type': 'NetClientDriver' }, diff --git a/qapi/qdev.json b/qapi/qdev.json index 2d73b27..6bc5a73 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -53,12 +53,12 @@ # # Notes: # -# Additional arguments depend on the type. +# 1. Additional arguments depend on the type. # -# 1. For detailed information about this command, please refer to the +# 2. For detailed information about this command, please refer to the # 'docs/qdev-device-use.txt' file. # -# 2. It's possible to list device properties by running QEMU with the +# 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 # diff --git a/qapi/qom.json b/qapi/qom.json index 7f92ea4..fa3e88c 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -647,9 +647,10 @@ # selects a default alignment (currently the page size). # (default: 0) # -# @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. (default: 0) (since 8.1) +# @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. +# (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. @@ -662,7 +663,7 @@ # # @pmem: specifies whether the backing file specified by @mem-path is # in host persistent memory that can be accessed using the SNIA -# NVM programming model (e.g. Intel NVDIMM). +# NVM programming model (e.g. Intel NVDIMM). # # @readonly: if true, the backing file is opened read-only; if false, # it is opened read-write. (default: false) diff --git a/qapi/trace.json b/qapi/trace.json index 39b752f..2077d7e 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -38,6 +38,7 @@ # @vcpu: Whether this is a per-vCPU event (since 2.7). # # Features: +# # @deprecated: Member @vcpu is deprecated, and always ignored. # # Since: 2.2 @@ -56,13 +57,11 @@ # @vcpu: The vCPU to query (since 2.7). # # Features: +# # @deprecated: Member @vcpu is deprecated, and always ignored. # # Returns: a list of @TraceEventInfo for the matching events # -# An event is returned if its name matches the @name pattern -# (There are no longer any per-vCPU events). -# # Since: 2.2 # # Example: @@ -90,10 +89,8 @@ # @vcpu: The vCPU to act upon (all by default; since 2.7). # # Features: -# @deprecated: Member @vcpu is deprecated, and always ignored. # -# An event is enabled if its name matches the @name pattern -# (There are no longer any per-vCPU events). +# @deprecated: Member @vcpu is deprecated, and always ignored. # # Since: 2.2 # diff --git a/qapi/ui.json b/qapi/ui.json index bb06fb6..006616a 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -1309,7 +1309,7 @@ # defaults to "off". (Since 3.1) # # @show-tabs: Display the tab bar for switching between the various -# graphical interfaces (e.g. VGA and virtual console character +# graphical interfaces (e.g. VGA and virtual console character # devices) by default. (Since 7.1) # # @show-menubar: Display the main window menubar. Defaults to "on". |