qemu/docs/tools
Hanna Reitz 111fbd74f6 qemu-img: Unify [-b [-F]] documentation
qemu-img convert documents the backing file and backing format options
as follows:
    [-B backing_file [-F backing_fmt]]
whereas qemu-img create has this:
    [-b backing_file] [-F backing_fmt]

That is, for convert, we document that -F cannot be given without -B,
while for create, way say that they are independent.

Indeed, it is technically possible to give -F without -b, because it is
left to the block driver to decide whether this is an error or not, so
sometimes it is:

$ qemu-img create -f qed -F qed test.qed 64M
Formatting 'test.qed', fmt=qed size=67108864 backing_fmt=qed [...]

And sometimes it is not:

$ qemu-img create -f qcow2 -F qcow2 test.qcow2 64M
Formatting 'test.qcow2', fmt=qcow2 cluster_size=65536 [...]
qemu-img: test.qcow2: Backing format cannot be used without backing file

Generally, it does not make much sense, though, and users should only
give -F with -b, so document it that way, as we have already done for
qemu-img convert (commit 1899bf4737).

Reported-by: Tingting Mao <timao@redhat.com>
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
Message-Id: <20220131135908.32393-1-hreitz@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2022-02-01 13:49:15 +01:00
..
index.rst docs: standardize directory index to --- with overline 2021-09-13 13:56:26 +02:00
qemu-img.rst qemu-img: Unify [-b [-F]] documentation 2022-02-01 13:49:15 +01:00
qemu-nbd.rst docs: Render binary names as monospaced text 2021-11-22 15:02:38 +01:00
qemu-pr-helper.rst docs: standardize book titles to === with overline 2021-09-13 13:56:26 +02:00
qemu-storage-daemon.rst qsd: Document fuse's allow-other option 2022-02-01 13:49:15 +01:00
qemu-trace-stap.rst docs/tools/qemu-trace-stap.rst: Do not hard-code the QEMU binary name 2022-01-05 11:10:13 +01:00
virtfs-proxy-helper.rst docs: Move tools documentation to tools manual 2020-02-25 10:48:06 +00:00
virtiofsd.rst docs: Render binary names as monospaced text 2021-11-22 15:02:38 +01:00