qemu/qapi
Markus Armbruster f0e0c46309 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>
2024-08-06 20:12:39 +02:00
..
acpi.json qapi: convert "Example" sections without titles 2024-07-17 10:20:53 +02:00
audio.json
authz.json
block-core.json qapi-block-core: Clean up blockdev-snapshot-internal-sync doc 2024-08-06 20:12:39 +02:00
block-export.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
block.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
char.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
common.json
compat.json
control.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
crypto.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
cryptodev.json
cxl.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
dump.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
ebpf.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
error.json
introspect.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
job.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
machine-common.json
machine-target.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
machine.json qmp: Fix higher half vaddrs for [p]memsave 2024-08-05 09:34:34 +02:00
meson.build
migration.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
misc-target.json qapi: convert "Example" sections without titles 2024-07-17 10:20:53 +02:00
misc.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
net.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
opts-visitor.c
pci.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
pragma.json
qapi-clone-visitor.c
qapi-dealloc-visitor.c
qapi-forward-visitor.c
qapi-schema.json
qapi-type-helpers.c
qapi-util.c
qapi-visit-core.c
qdev.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
qmp-dispatch.c
qmp-event.c
qmp-registry.c
qobject-input-visitor.c
qobject-output-visitor.c
qom.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
replay.json qapi: convert "Example" sections without titles 2024-07-17 10:20:53 +02:00
rocker.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
run-state.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
sockets.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
stats.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
string-input-visitor.c
string-output-visitor.c
tpm.json qapi: convert "Example" sections without titles 2024-07-17 10:20:53 +02:00
trace-events
trace.h
trace.json qapi: convert "Example" sections without titles 2024-07-17 10:20:53 +02:00
transaction.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
ui.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
vfio.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
virtio.json qapi: Refill doc comments to conform to conventions 2024-08-05 09:31:51 +02:00
yank.json qapi: convert "Example" sections without titles 2024-07-17 10:20:53 +02:00