vitalif
/
mirror_qemu
mirror of https://github.com/proxmox/mirror_qemu
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

qapi: Delete useless "Returns" sections 

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-6-armbru@redhat.com>
master
Markus Armbruster 2024-02-27 12:39:13 +01:00
parent 2746f060be
commit 53d5c36d8d
17 changed files with 1 additions and 183 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
qapi/block-core.json
View File

@ -1456,9 +1456,6 @@
#
# @size: new image size in bytes
#
# Returns:
# - nothing on success
#
# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
@ -1676,9 +1673,6 @@
#
# For the arguments, see the documentation of BlockdevSnapshotSync.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
@ -1758,9 +1752,6 @@
# is not validated, so care should be taken when specifying the
# string or the image chain may not be able to be reopened again.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If "device" does not exist or cannot be determined,
# DeviceNotFound
@ -1860,9 +1851,6 @@
# @deprecated: Members @base and @top are deprecated. Use @base-node
# and @top-node instead.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @device does not exist, DeviceNotFound
# - Any other error returns a GenericError.
@ -1902,9 +1890,6 @@
# @deprecated: This command is deprecated. Use @blockdev-backup
# instead.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @device is not a valid block device, GenericError
#
@ -1931,9 +1916,6 @@
# 'backup'. The operation can be stopped before it has completed using
# the block-job-cancel command.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
@ -2139,9 +2121,6 @@
# specifies the format of the mirror image, default is to probe if
# mode='existing', else the format of the source.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @device is not a valid block device, GenericError
#
@ -2318,9 +2297,6 @@
# Create a dirty bitmap with a name on the node, and start tracking
# the writes.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @node is not a valid block device or node, DeviceNotFound
# - If @name is already taken, GenericError with an explanation
@ -2344,9 +2320,6 @@
# with block-dirty-bitmap-add. If the bitmap is persistent, remove it
# from its storage too.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @node is not a valid block device or node, DeviceNotFound
# - If @name is not found, GenericError with an explanation
@ -2371,9 +2344,6 @@
# backup from this point in time forward will only backup clusters
# modified after this clear operation.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If @name is not found, GenericError with an explanation
@ -2395,9 +2365,6 @@
#
# Enables a dirty bitmap so that it will begin tracking disk changes.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If @name is not found, GenericError with an explanation
@ -2419,9 +2386,6 @@
#
# Disables a dirty bitmap so that it will stop tracking disk changes.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If @name is not found, GenericError with an explanation
@ -2451,9 +2415,6 @@
# dirty in any of the source bitmaps. This can be used to achieve
# backup checkpoints, or in simpler usages, to copy bitmaps.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @node is not a valid block device, DeviceNotFound
# - If any bitmap in @bitmaps or @target is not found,
@ -2570,8 +2531,6 @@
# disappear from the query list without user intervention.
# Defaults to true. (Since 3.1)
#
# Returns: nothing on success.
#
# Since: 2.6
#
# Example:
@ -2894,9 +2853,6 @@
# disappear from the query list without user intervention.
# Defaults to true. (Since 3.1)
#
# Returns:
# - Nothing on success.
#
# Errors:
# - If @device does not exist, DeviceNotFound.
#
@ -2935,9 +2891,6 @@
# @speed: the maximum speed, in bytes per second, or 0 for unlimited.
# Defaults to 0.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
@ -2982,9 +2935,6 @@
# paused) instead of waiting for the destination to complete its
# final synchronization (since 1.3)
#
# Returns:
# - Nothing on success
#
# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
@ -3011,9 +2961,6 @@
# the name of the parameter), but since QEMU 2.7 it can have other
# values.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
@ -3038,9 +2985,6 @@
# the name of the parameter), but since QEMU 2.7 it can have other
# values.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
@ -3072,9 +3016,6 @@
# the name of the parameter), but since QEMU 2.7 it can have other
# values.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If no background operation is active on this device,
# DeviceNotActive
@ -3099,8 +3040,6 @@
#
# @id: The job identifier.
#
# Returns: Nothing on success
#
# Since: 2.12
##
{ 'command': 'block-job-dismiss', 'data': { 'id': 'str' },
@ -3118,8 +3057,6 @@
#
# @id: The job identifier.
#
# Returns: Nothing on success
#
# Since: 2.12
##
{ 'command': 'block-job-finalize', 'data': { 'id': 'str' },
@ -6110,9 +6047,6 @@
# For the arguments, see the documentation of
# BlockdevSnapshotInternal.
#
# Returns:
# - nothing on success
#
# Errors:
# - If @device is not a valid block device, GenericError
# - If any snapshot matching @name exists, or @name is empty,

6
qapi/block.json
View File

@ -110,9 +110,6 @@
#
# @deprecated: Member @device is deprecated. Use @id instead.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
@ -461,9 +458,6 @@
# the device will be removed from its group and the rest of its
# members will not be affected. The 'group' parameter is ignored.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @device is not a valid block device, DeviceNotFound
#

6
qapi/char.json
View File

@ -139,8 +139,6 @@
# - data itself is always Unicode regardless of format, like any
# other string.
#
# Returns: Nothing on success
#
# Since: 1.4
#
# Example:
@ -772,8 +770,6 @@
#
# @id: the chardev's ID, must exist and not be in use
#
# Returns: Nothing on success
#
# Since: 1.4
#
# Example:
@ -791,8 +787,6 @@
#
# @id: the chardev's ID, must exist
#
# Returns: Nothing on success
#
# Since: 2.10
#
# Example:

2
qapi/dump.json
View File

@ -92,8 +92,6 @@
#
# Note: All boolean arguments default to false
#
# Returns: nothing on success
#
# Since: 1.2
#
# Example:

2
qapi/machine-target.json
View File

@ -414,8 +414,6 @@
#
# @unstable: This command is experimental.
#
# Returns: Nothing on success.
#
# Since: 8.2
##
{ 'command': 'set-cpu-topology',

11
qapi/machine.json
View File

@ -326,8 +326,6 @@
#
# Since: 1.1
#
# Returns: nothing.
#
# Note: prior to 4.0, this command does nothing in case the guest
# isn't suspended.
#
@ -377,8 +375,6 @@
# all CPUs (ppc64). The command fails when the guest doesn't support
# injecting.
#
# Returns: If successful, nothing
#
# Since: 0.14
#
# Note: prior to 2.1, this command was only supported for x86 and s390
@ -778,8 +774,6 @@
# @cpu-index: the index of the virtual CPU to use for translating the
# virtual address (defaults to CPU 0)
#
# Returns: Nothing on success
#
# Since: 0.14
#
# Notes: Errors were not reliably returned until 1.1
@ -806,8 +800,6 @@
#
# @filename: the file to save the memory to as binary data
#
# Returns: Nothing on success
#
# Since: 0.14
#
# Notes: Errors were not reliably returned until 1.1
@ -1060,9 +1052,6 @@
#
# From it we have: balloon_size = vm_ram_size - @value
#
# Returns:
# - Nothing on success
#
# Errors:
# - If the balloon driver is enabled but not functional because
# the KVM kernel module cannot support it, KVMMissingCap

26
qapi/migration.json
View File

@ -1566,8 +1566,6 @@
#
# Cancel the current executing migration process.
#
# Returns: nothing on success
#
# Notes: This command succeeds even if there is no migration process
# running.
#
@ -1587,8 +1585,6 @@
#
# @state: The state the migration is currently expected to be in
#
# Returns: nothing on success
#
# Since: 2.11
#
# Example:
@ -1710,8 +1706,6 @@
# @deprecated: Members @inc and @blk are deprecated. Use
# blockdev-mirror with NBD instead.
#
# Returns: nothing on success
#
# Since: 0.14
#
# Notes:
@ -1793,8 +1787,6 @@
# @channels: list of migration stream channels with each stream in the
# list connected to a destination interface endpoint.
#
# Returns: nothing on success
#
# Since: 2.3
#
# Notes:
@ -1862,8 +1854,6 @@
# @live: Optional argument to ask QEMU to treat this command as part
# of a live migration. Default to true. (since 2.11)
#
# Returns: Nothing on success
#
# Since: 1.1
#
# Example:
@ -1882,8 +1872,6 @@
#
# @enable: true to enable, false to disable.
#
# Returns: nothing
#
# Since: 1.3
#
# Example:
@ -1926,8 +1914,6 @@
# @failover: true to do failover, false to stop. but cannot be
# specified if 'enable' is true. default value is false.
#
# Returns: nothing.
#
# Example:
#
# -> { "execute": "xen-set-replication",
@ -1979,8 +1965,6 @@
#
# Xen uses this command to notify replication to trigger a checkpoint.
#
# Returns: nothing.
#
# Example:
#
# -> { "execute": "xen-colo-do-checkpoint" }
@ -2037,8 +2021,6 @@
#
# @uri: the URI to be used for the recovery of migration stream.
#
# Returns: nothing.
#
# Example:
#
# -> { "execute": "migrate-recover",
@ -2056,8 +2038,6 @@
#
# Pause a migration. Currently it only supports postcopy.
#
# Returns: nothing.
#
# Example:
#
# -> { "execute": "migrate-pause" }
@ -2426,8 +2406,6 @@
#
# If @tag already exists, an error will be reported
#
# Returns: nothing
#
# Example:
#
# -> { "execute": "snapshot-save",
@ -2498,8 +2476,6 @@
# device nodes that can have changed since the original @snapshot-save
# command execution.
#
# Returns: nothing
#
# Example:
#
# -> { "execute": "snapshot-load",
@ -2561,8 +2537,6 @@
# to determine completion and to fetch details of any errors that
# arise.
#
# Returns: nothing
#
# Example:
#
# -> { "execute": "snapshot-delete",

3
qapi/misc-target.json
View File

@ -472,9 +472,6 @@
#
# @port: The port number
#
# Returns:
# - Nothing on success.
#
# Since: 8.0
#
# Example:

15
qapi/misc.json
View File

@ -28,8 +28,6 @@
#
# @tls: whether to perform TLS. Only applies to the "spice" protocol
#
# Returns: nothing on success.
#
# Since: 0.14
#
# Example:
@ -160,8 +158,6 @@
#
# Since: 0.14
#
# Returns: If successful, nothing
#
# Notes: 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
@ -196,8 +192,6 @@
#
# Since: 3.0
#
# Returns: nothing
#
# Example:
#
# -> { "execute": "x-exit-preconfig" }
@ -256,8 +250,6 @@
#
# @fdname: file descriptor name
#
# Returns: Nothing on success
#
# Since: 0.14
#
# Notes: If @fdname already exists, the file descriptor assigned to it
@ -285,8 +277,6 @@
#
# @fdname: file descriptor name
#
# Returns: Nothing on success
#
# Since: 8.0
#
# Notes: If @fdname already exists, the file descriptor assigned to it
@ -309,8 +299,6 @@
#
# @fdname: file descriptor name
#
# Returns: Nothing on success
#
# Since: 0.14
#
# Example:
@ -376,9 +364,6 @@
#
# @fd: The file descriptor that is to be removed.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @fdset-id or @fd is not found, GenericError
#

9
qapi/net.json
View File

@ -17,9 +17,6 @@
#
# @up: true to set the link status to be up
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @name is not a valid network device, DeviceNotFound
#
@ -46,9 +43,6 @@
#
# Since: 0.14
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @type is not a valid network backend, DeviceNotFound
#
@ -69,9 +63,6 @@
#
# @id: the name of the network backend to remove
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @id is not a valid network backend, DeviceNotFound
#

3
qapi/qdev.json
View File

@ -89,9 +89,6 @@
#
# @id: the device's ID or QOM path
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @id is not a valid device, DeviceNotFound
#

6
qapi/qom.json
View File

@ -1056,9 +1056,6 @@
#
# Create a QOM object.
#
# Returns:
# - Nothing on success
#
# Errors:
# - Error if @qom-type is not a valid class name
#
@ -1081,9 +1078,6 @@
#
# @id: the name of the QOM object to remove
#
# Returns:
# - Nothing on success
#
# Errors:
# - Error if @id is not a valid id for a QOM object
#

5
qapi/run-state.json
View File

@ -395,10 +395,7 @@
#
# @panic: @PanicAction action taken on guest panic.
#
# @watchdog: @WatchdogAction action taken when watchdog timer expires
# .
#
# Returns: Nothing on success.
# @watchdog: @WatchdogAction action taken when watchdog timer expires.
#
# Since: 6.0
#

2
qapi/tpm.json
View File

@ -166,8 +166,6 @@
#
# Return information about the TPM device
#
# Returns: @TPMInfo on success
#
# Since: 1.5
#
# Example:

2
qapi/transaction.json
View File

@ -234,8 +234,6 @@
# execution of the transaction. See @TransactionProperties for
# additional detail.
#
# Returns: nothing on success
#
# Errors:
# Any errors from commands in the transaction
#

17
qapi/ui.json
View File

@ -78,9 +78,6 @@
#
# Set the password of a remote display server.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If Spice is not enabled, DeviceNotFound
#
@ -142,9 +139,6 @@
#
# Expire the password of a remote display server.
#
# Returns:
# - Nothing on success
#
# Errors:
# - If @protocol is 'spice' and Spice is not active,
# DeviceNotFound
@ -191,8 +185,6 @@
#
# @format: image format for screendump. (default: ppm) (Since 7.1)
#
# Returns: Nothing on success
#
# Since: 0.14
#
# Example:
@ -1040,9 +1032,6 @@
# @hold-time: time to delay key up events, milliseconds. Defaults to
# 100
#
# Returns:
# - Nothing on success
#
# Errors:
# - If key is unknown or redundant, GenericError
#
@ -1265,8 +1254,6 @@
#
# @events: List of InputEvent union.
#
# Returns: Nothing on success.
#
# Since: 2.6
#
# Note: The consoles are visible in the qom tree, under
@ -1611,8 +1598,6 @@
#
# Reload display configuration.
#
# Returns: Nothing on success.
#
# Since: 6.0
#
# Example:
@ -1670,8 +1655,6 @@
#
# Update display configuration.
#
# Returns: Nothing on success.
#
# Since: 7.1
#
# Example:

3
qapi/yank.json
View File

@ -78,9 +78,6 @@
#
# @instances: the instances to be yanked
#
# Returns:
# - Nothing on success
#
# Errors:
# - @DeviceNotFound error, if any of the YankInstances doesn't exist
#