Skip to content

Commit

Permalink
qapi: Delete useless "Returns" sections
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-6-armbru@redhat.com>
  • Loading branch information
Markus Armbruster committed Mar 4, 2024
1 parent 2746f06 commit 53d5c36
Show file tree
Hide file tree
Showing 17 changed files with 1 addition and 183 deletions.
66 changes: 0 additions & 66 deletions qapi/block-core.json
Original file line number Diff line number Diff line change
Expand Up @@ -1456,9 +1456,6 @@
#
# @size: new image size in bytes
#
# Returns:
# - nothing on success
#
# Errors:
# - If @device is not a valid block device, DeviceNotFound
#
Expand Down Expand Up @@ -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
#
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
#
Expand All @@ -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
#
Expand Down Expand Up @@ -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
#
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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.
#
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -3099,8 +3040,6 @@
#
# @id: The job identifier.
#
# Returns: Nothing on success
#
# Since: 2.12
##
{ 'command': 'block-job-dismiss', 'data': { 'id': 'str' },
Expand All @@ -3118,8 +3057,6 @@
#
# @id: The job identifier.
#
# Returns: Nothing on success
#
# Since: 2.12
##
{ 'command': 'block-job-finalize', 'data': { 'id': 'str' },
Expand Down Expand Up @@ -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,
Expand Down
6 changes: 0 additions & 6 deletions qapi/block.json
Original file line number Diff line number Diff line change
Expand Up @@ -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
#
Expand Down Expand Up @@ -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
#
Expand Down
6 changes: 0 additions & 6 deletions qapi/char.json
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,6 @@
# - data itself is always Unicode regardless of format, like any
# other string.
#
# Returns: Nothing on success
#
# Since: 1.4
#
# Example:
Expand Down Expand Up @@ -772,8 +770,6 @@
#
# @id: the chardev's ID, must exist and not be in use
#
# Returns: Nothing on success
#
# Since: 1.4
#
# Example:
Expand All @@ -791,8 +787,6 @@
#
# @id: the chardev's ID, must exist
#
# Returns: Nothing on success
#
# Since: 2.10
#
# Example:
Expand Down
2 changes: 0 additions & 2 deletions qapi/dump.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,6 @@
#
# Note: All boolean arguments default to false
#
# Returns: nothing on success
#
# Since: 1.2
#
# Example:
Expand Down
2 changes: 0 additions & 2 deletions qapi/machine-target.json
Original file line number Diff line number Diff line change
Expand Up @@ -414,8 +414,6 @@
#
# @unstable: This command is experimental.
#
# Returns: Nothing on success.
#
# Since: 8.2
##
{ 'command': 'set-cpu-topology',
Expand Down
11 changes: 0 additions & 11 deletions qapi/machine.json
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 53d5c36

Please sign in to comment.