]> xenbits.xensource.com Git - people/aperard/qemu-dm.git/commit
qapi-block-core: Clean up blockdev-snapshot-internal-sync doc
authorMarkus Armbruster <armbru@redhat.com>
Thu, 18 Jul 2024 12:36:09 +0000 (14:36 +0200)
committerKevin Wolf <kwolf@redhat.com>
Tue, 6 Aug 2024 18:12:39 +0000 (20:12 +0200)
commitf0e0c46309dac41a8420bcb379b1cffa7da0f62c
tree610d7bed17c0fb7b70bf1c80427750d8e5c9b998
parentc659b7b3b4925f8cef486a3ee64e911519495782
qapi-block-core: Clean up blockdev-snapshot-internal-sync doc

BlockdevSnapshotInternal is the arguments type of command
blockdev-snapshot-internal-sync.  Its doc comment contains this note:

    # .. note:: In a transaction, if @name is empty or any snapshot matching
    #    @name exists, the operation will fail.  Only some image formats
    #    support it; for example, qcow2, and rbd.

"In a transaction" is misleading, and "if @name is empty or any
snapshot matching @name exists, the operation will fail" is redundant
with the command's Errors documentation.  Drop.

The remainder is fine.  Move it to the command's doc comment, where it
is more prominently visible, with a slight rephrasing for clarity.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240718123609.3063055-1-armbru@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
qapi/block-core.json