qapi: Clean up "Returns" sections
authorMarkus Armbruster <armbru@redhat.com>
Tue, 27 Feb 2024 11:39:14 +0000 (12:39 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 4 Mar 2024 06:12:40 +0000 (07:12 +0100)
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>

qapi/block-core.json
qapi/machine.json
qapi/misc.json

index 94b01deffc51ec5dbd1e292139fa8f9dff320056..1874f880a8decbf0e1278679cc18f792ba619359 100644 (file)
 # @unstable: This command is meant for debugging.
 #
 # Returns:
-#     - BlockDirtyBitmapSha256 on success
+#     BlockDirtyBitmapSha256
 #
 # Errors:
 #     - If @node is not a valid block device, DeviceNotFound
 # @name: optional the snapshot's name to be deleted
 #
 # Returns:
-#     - SnapshotInfo on success
+#     SnapshotInfo
 #
 # Errors:
 #     - If @device is not a valid block device, GenericError
index 7d3ca33683b49f9ac59993138647a3a1d0694974..bb5a17890944f9bff8d863cf67d554631a8275f0 100644 (file)
 # Return information about the balloon device.
 #
 # Returns:
-#     - @BalloonInfo on success
+#     @BalloonInfo
 #
 # Errors:
 #     - If the balloon driver is enabled but not functional because
 # message from the guest.
 #
 # Returns:
-#     - @HvBalloonInfo on success
+#     @HvBalloonInfo
 #
 # Errors:
 #     - If no hv-balloon device is present, guest memory status
index 015388aa3eed11c893b31966dd99de5a0c81c3da..1b0c5dad8824b0ff51f29a5087965169ba38b750 100644 (file)
 # @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