ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Markus Armbruster 2024-07-18 14:36:09 +02:00 committed by Kevin Wolf
parent c659b7b3b4
commit f0e0c46309
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
qapi/block-core.json
View File

@ -6047,10 +6047,6 @@
#
# @name: the name of the internal snapshot to be created
#
# .. 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.
#
# Since: 1.7
##
{ 'struct': 'BlockdevSnapshotInternal',
@ -6071,6 +6067,9 @@
# - If the format of the image used does not support it,
# GenericError
#
# .. note:: Only some image formats such as qcow2 and rbd support
# internal snapshots.
#
# Since: 1.7
#
# .. qmp-example::