Skip to content

Commit

Permalink
qapi: Clean up "Returns" sections
Browse files Browse the repository at this point in the history
Drop list markup, since there's just one item left.

Drop "on success" where it is redundant with "Returns:".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-7-armbru@redhat.com>
  • Loading branch information
Markus Armbruster committed Mar 4, 2024
1 parent 53d5c36 commit e2c1dcb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions qapi/block-core.json
Original file line number Diff line number Diff line change
Expand Up @@ -2457,7 +2457,7 @@
# @unstable: This command is meant for debugging.
#
# Returns:
# - BlockDirtyBitmapSha256 on success
# BlockDirtyBitmapSha256
#
# Errors:
# - If @node is not a valid block device, DeviceNotFound
Expand Down Expand Up @@ -6084,7 +6084,7 @@
# @name: optional the snapshot's name to be deleted
#
# Returns:
# - SnapshotInfo on success
# SnapshotInfo
#
# Errors:
# - If @device is not a valid block device, GenericError
Expand Down
4 changes: 2 additions & 2 deletions qapi/machine.json
Original file line number Diff line number Diff line change
Expand Up @@ -1090,7 +1090,7 @@
# Return information about the balloon device.
#
# Returns:
# - @BalloonInfo on success
# @BalloonInfo
#
# Errors:
# - If the balloon driver is enabled but not functional because
Expand Down Expand Up @@ -1156,7 +1156,7 @@
# message from the guest.
#
# Returns:
# - @HvBalloonInfo on success
# @HvBalloonInfo
#
# Errors:
# - If no hv-balloon device is present, guest memory status
Expand Down
2 changes: 1 addition & 1 deletion qapi/misc.json
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@
# @opaque: A free-form string that can be used to describe the fd.
#
# Returns:
# - @AddfdInfo on success
# @AddfdInfo
#
# Errors:
# - If file descriptor was not received, GenericError
Expand Down

0 comments on commit e2c1dcb

Please sign in to comment.