]> git.proxmox.com Git - mirror_qemu.git/commit
qemu-img: Unify [-b [-F]] documentation
authorHanna Reitz <hreitz@redhat.com>
Mon, 31 Jan 2022 13:59:08 +0000 (14:59 +0100)
committerKevin Wolf <kwolf@redhat.com>
Tue, 1 Feb 2022 12:49:15 +0000 (13:49 +0100)
commit111fbd74f67575c158d9be5363825aab8be50a0a
treeaa08aa9ee7798a09c20d3a823de835db7d01f25d
parentcb90ec3a3646a3bdb0b2a157db226db25d470442
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 1899bf47375ad40555dcdff12ba49b4b8b82df38).

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>
docs/tools/qemu-img.rst
qemu-img-cmds.hx