[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 08/10] qemu-img: Unify [-b [-F]] documentation
From: |
Kevin Wolf |
Subject: |
[PULL 08/10] qemu-img: Unify [-b [-F]] documentation |
Date: |
Tue, 1 Feb 2022 16:21:06 +0100 |
From: Hanna Reitz <hreitz@redhat.com>
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 | 2 +-
qemu-img-cmds.hx | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
index d663dd92bd..8885ea11cf 100644
--- a/docs/tools/qemu-img.rst
+++ b/docs/tools/qemu-img.rst
@@ -463,7 +463,7 @@ Command description:
``--skip-broken-bitmaps`` is also specified to copy only the
consistent bitmaps.
-.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-F
BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE]
+.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F
BACKING_FMT]] [-u] [-o OPTIONS] FILENAME [SIZE]
Create the new disk image *FILENAME* of size *SIZE* and format
*FMT*. Depending on the file format, you can add one or more *OPTIONS*
diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
index 72bcdcfbfa..1b1dab5b17 100644
--- a/qemu-img-cmds.hx
+++ b/qemu-img-cmds.hx
@@ -52,9 +52,9 @@ SRST
ERST
DEF("create", img_create,
- "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F
backing_fmt] [-u] [-o options] filename [size]")
+ "create [--object objectdef] [-q] [-f fmt] [-b backing_file [-F
backing_fmt]] [-u] [-o options] filename [size]")
SRST
-.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-F
BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE]
+.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F
BACKING_FMT]] [-u] [-o OPTIONS] FILENAME [SIZE]
ERST
DEF("dd", img_dd,
--
2.31.1
- [PULL 00/10] Block layer patches, Kevin Wolf, 2022/02/01
- [PULL 02/10] block: bdrv_set_backing_hd(): use drained section, Kevin Wolf, 2022/02/01
- [PULL 03/10] block/export: Fix vhost-user-blk shutdown with requests in flight, Kevin Wolf, 2022/02/01
- [PULL 04/10] block/export/fuse: Rearrange if-else-if ladder in fuse_fallocate(), Kevin Wolf, 2022/02/01
- [PULL 05/10] block/export/fuse: Fix build failure on FreeBSD, Kevin Wolf, 2022/02/01
- [PULL 07/10] qsd: Document fuse's allow-other option, Kevin Wolf, 2022/02/01
- [PULL 08/10] qemu-img: Unify [-b [-F]] documentation,
Kevin Wolf <=
- [PULL 01/10] qemu-storage-daemon: Fix typo in vhost-user-blk help, Kevin Wolf, 2022/02/01
- [PULL 10/10] block/rbd: workaround for ceph issue #53784, Kevin Wolf, 2022/02/01
- [PULL 09/10] block/rbd: fix handling of holes in .bdrv_co_block_status, Kevin Wolf, 2022/02/01
- [PULL 06/10] block.h: remove outdated comment, Kevin Wolf, 2022/02/01
- Re: [PULL 00/10] Block layer patches, Peter Maydell, 2022/02/02