All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] qemu-img: Add -F shorthand to convert
@ 2021-09-13 13:17 Eric Blake
  2021-09-15  8:20 ` Vladimir Sementsov-Ogievskiy
                   ` (3 more replies)
  0 siblings, 4 replies; 6+ messages in thread
From: Eric Blake @ 2021-09-13 13:17 UTC (permalink / raw)
  To: qemu-devel; +Cc: Kevin Wolf, Hanna Reitz, berrange, qemu-block

Although we have long supported 'qemu-img convert -o
backing_file=foo,backing_fmt=bar', the fact that we have a shortcut -B
for backing_file but none for backing_fmt has made it more likely that
users accidentally run into:

qemu-img: warning: Deprecated use of backing file without explicit backing format

when using -B instead of -o.  For similarity with other qemu-img
commands, such as create and compare, add '-F $fmt' as the shorthand
for '-o backing_fmt=$fmt'.  Update iotest 122 for coverage of both
spellings.

Signed-off-by: Eric Blake <eblake@redhat.com>
---

This stemmed from an IRC conversation; I'd add a Reported-by: line if
I can figure out how to credit more than just the nick bparker_.

 docs/tools/qemu-img.rst |  4 ++--
 qemu-img.c              | 10 +++++++---
 qemu-img-cmds.hx        |  2 +-
 tests/qemu-iotests/122  |  2 +-
 4 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
index b7d602a28804..e02880c1c5dc 100644
--- a/docs/tools/qemu-img.rst
+++ b/docs/tools/qemu-img.rst
@@ -414,7 +414,7 @@ Command description:
   4
     Error on reading data

-.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
+.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE [-F backing_fmt]] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME

   Convert the disk image *FILENAME* or a snapshot *SNAPSHOT_PARAM*
   to disk image *OUTPUT_FILENAME* using format *OUTPUT_FMT*. It can
@@ -438,7 +438,7 @@ Command description:
   You can use the *BACKING_FILE* option to force the output image to be
   created as a copy on write image of the specified base image; the
   *BACKING_FILE* should have the same content as the input's base image,
-  however the path, image format, etc may differ.
+  however the path, image format (as given by *BACKING_FMT*), etc may differ.

   If a relative path name is given, the backing file is looked up relative to
   the directory containing *OUTPUT_FILENAME*.
diff --git a/qemu-img.c b/qemu-img.c
index d77f3e76a9b6..290368da7d6d 100644
--- a/qemu-img.c
+++ b/qemu-img.c
@@ -2183,7 +2183,8 @@ static int img_convert(int argc, char **argv)
     int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
     const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
                *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
-               *out_filename, *out_baseimg_param, *snapshot_name = NULL;
+               *out_filename, *out_baseimg_param, *snapshot_name = NULL,
+               *backing_fmt = NULL;
     BlockDriver *drv = NULL, *proto_drv = NULL;
     BlockDriverInfo bdi;
     BlockDriverState *out_bs;
@@ -2223,7 +2224,7 @@ static int img_convert(int argc, char **argv)
             {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
             {0, 0, 0, 0}
         };
-        c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WUr:",
+        c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
                         long_options, NULL);
         if (c == -1) {
             break;
@@ -2253,6 +2254,9 @@ static int img_convert(int argc, char **argv)
         case 'c':
             s.compressed = true;
             break;
+        case 'F':
+            backing_fmt = optarg;
+            break;
         case 'o':
             if (accumulate_options(&options, optarg) < 0) {
                 goto fail_getopt;
@@ -2521,7 +2525,7 @@ static int img_convert(int argc, char **argv)

         qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
                             s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
-        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
+        ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
         if (ret < 0) {
             goto out;
         }
diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
index b3620f29e50c..4c4d94ab2267 100644
--- a/qemu-img-cmds.hx
+++ b/qemu-img-cmds.hx
@@ -46,7 +46,7 @@ SRST
 ERST

 DEF("convert", img_convert,
-    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
+    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file [-F backing_fmt]] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
 SRST
 .. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
 ERST
diff --git a/tests/qemu-iotests/122 b/tests/qemu-iotests/122
index 5d550ed13ea3..efb260d822db 100755
--- a/tests/qemu-iotests/122
+++ b/tests/qemu-iotests/122
@@ -67,7 +67,7 @@ echo
 _make_test_img -b "$TEST_IMG".base -F $IMGFMT

 $QEMU_IO -c "write -P 0 0 3M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
-$QEMU_IMG convert -O $IMGFMT -B "$TEST_IMG".base -o backing_fmt=$IMGFMT \
+$QEMU_IMG convert -O $IMGFMT -B "$TEST_IMG".base -F $IMGFMT \
     "$TEST_IMG" "$TEST_IMG".orig
 $QEMU_IO -c "read -P 0 0 3M" "$TEST_IMG".orig 2>&1 | _filter_qemu_io | _filter_testdir
 $QEMU_IMG convert -O $IMGFMT -c -B "$TEST_IMG".base -o backing_fmt=$IMGFMT \
-- 
2.31.1



^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH] qemu-img: Add -F shorthand to convert
  2021-09-13 13:17 [PATCH] qemu-img: Add -F shorthand to convert Eric Blake
@ 2021-09-15  8:20 ` Vladimir Sementsov-Ogievskiy
  2021-09-15  8:33 ` Maxim Levitsky
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 6+ messages in thread
From: Vladimir Sementsov-Ogievskiy @ 2021-09-15  8:20 UTC (permalink / raw)
  To: Eric Blake, qemu-devel; +Cc: Kevin Wolf, Hanna Reitz, berrange, qemu-block

13.09.2021 16:17, Eric Blake wrote:
> Although we have long supported 'qemu-img convert -o
> backing_file=foo,backing_fmt=bar', the fact that we have a shortcut -B
> for backing_file but none for backing_fmt has made it more likely that
> users accidentally run into:
> 
> qemu-img: warning: Deprecated use of backing file without explicit backing format
> 
> when using -B instead of -o.  For similarity with other qemu-img
> commands, such as create and compare, add '-F $fmt' as the shorthand
> for '-o backing_fmt=$fmt'.  Update iotest 122 for coverage of both
> spellings.
> 
> Signed-off-by: Eric Blake<eblake@redhat.com>

Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>

-- 
Best regards,
Vladimir


^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] qemu-img: Add -F shorthand to convert
  2021-09-13 13:17 [PATCH] qemu-img: Add -F shorthand to convert Eric Blake
  2021-09-15  8:20 ` Vladimir Sementsov-Ogievskiy
@ 2021-09-15  8:33 ` Maxim Levitsky
  2021-09-15 11:19 ` Hanna Reitz
  2021-09-17 20:13 ` Eric Blake
  3 siblings, 0 replies; 6+ messages in thread
From: Maxim Levitsky @ 2021-09-15  8:33 UTC (permalink / raw)
  To: Eric Blake, qemu-devel; +Cc: Kevin Wolf, Hanna Reitz, berrange, qemu-block

On Mon, 2021-09-13 at 08:17 -0500, Eric Blake wrote:
> Although we have long supported 'qemu-img convert -o
> backing_file=foo,backing_fmt=bar', the fact that we have a shortcut -B
> for backing_file but none for backing_fmt has made it more likely that
> users accidentally run into:
> 
> qemu-img: warning: Deprecated use of backing file without explicit backing format
> 
> when using -B instead of -o.  For similarity with other qemu-img
> commands, such as create and compare, add '-F $fmt' as the shorthand
> for '-o backing_fmt=$fmt'.  Update iotest 122 for coverage of both
> spellings.
> 
> Signed-off-by: Eric Blake <eblake@redhat.com>
> ---
> 
> This stemmed from an IRC conversation; I'd add a Reported-by: line if
> I can figure out how to credit more than just the nick bparker_.
> 
>  docs/tools/qemu-img.rst |  4 ++--
>  qemu-img.c              | 10 +++++++---
>  qemu-img-cmds.hx        |  2 +-
>  tests/qemu-iotests/122  |  2 +-
>  4 files changed, 11 insertions(+), 7 deletions(-)
> 
> diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
> index b7d602a28804..e02880c1c5dc 100644
> --- a/docs/tools/qemu-img.rst
> +++ b/docs/tools/qemu-img.rst
> @@ -414,7 +414,7 @@ Command description:
>    4
>      Error on reading data
> 
> -.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
> +.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE [-F backing_fmt]] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
> 
>    Convert the disk image *FILENAME* or a snapshot *SNAPSHOT_PARAM*
>    to disk image *OUTPUT_FILENAME* using format *OUTPUT_FMT*. It can
> @@ -438,7 +438,7 @@ Command description:
>    You can use the *BACKING_FILE* option to force the output image to be
>    created as a copy on write image of the specified base image; the
>    *BACKING_FILE* should have the same content as the input's base image,
> -  however the path, image format, etc may differ.
> +  however the path, image format (as given by *BACKING_FMT*), etc may differ.
> 
>    If a relative path name is given, the backing file is looked up relative to
>    the directory containing *OUTPUT_FILENAME*.
> diff --git a/qemu-img.c b/qemu-img.c
> index d77f3e76a9b6..290368da7d6d 100644
> --- a/qemu-img.c
> +++ b/qemu-img.c
> @@ -2183,7 +2183,8 @@ static int img_convert(int argc, char **argv)
>      int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
>      const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
>                 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
> -               *out_filename, *out_baseimg_param, *snapshot_name = NULL;
> +               *out_filename, *out_baseimg_param, *snapshot_name = NULL,
> +               *backing_fmt = NULL;
>      BlockDriver *drv = NULL, *proto_drv = NULL;
>      BlockDriverInfo bdi;
>      BlockDriverState *out_bs;
> @@ -2223,7 +2224,7 @@ static int img_convert(int argc, char **argv)
>              {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
>              {0, 0, 0, 0}
>          };
> -        c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WUr:",
> +        c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
>                          long_options, NULL);
>          if (c == -1) {
>              break;
> @@ -2253,6 +2254,9 @@ static int img_convert(int argc, char **argv)
>          case 'c':
>              s.compressed = true;
>              break;
> +        case 'F':
> +            backing_fmt = optarg;
> +            break;
>          case 'o':
>              if (accumulate_options(&options, optarg) < 0) {
>                  goto fail_getopt;
> @@ -2521,7 +2525,7 @@ static int img_convert(int argc, char **argv)
> 
>          qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
>                              s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
> -        ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
> +        ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
>          if (ret < 0) {
>              goto out;
>          }
> diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
> index b3620f29e50c..4c4d94ab2267 100644
> --- a/qemu-img-cmds.hx
> +++ b/qemu-img-cmds.hx
> @@ -46,7 +46,7 @@ SRST
>  ERST
> 
>  DEF("convert", img_convert,
> -    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
> +    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file [-F backing_fmt]] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
>  SRST
>  .. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
>  ERST
> diff --git a/tests/qemu-iotests/122 b/tests/qemu-iotests/122
> index 5d550ed13ea3..efb260d822db 100755
> --- a/tests/qemu-iotests/122
> +++ b/tests/qemu-iotests/122
> @@ -67,7 +67,7 @@ echo
>  _make_test_img -b "$TEST_IMG".base -F $IMGFMT
> 
>  $QEMU_IO -c "write -P 0 0 3M" "$TEST_IMG" 2>&1 | _filter_qemu_io | _filter_testdir
> -$QEMU_IMG convert -O $IMGFMT -B "$TEST_IMG".base -o backing_fmt=$IMGFMT \
> +$QEMU_IMG convert -O $IMGFMT -B "$TEST_IMG".base -F $IMGFMT \
>      "$TEST_IMG" "$TEST_IMG".orig
>  $QEMU_IO -c "read -P 0 0 3M" "$TEST_IMG".orig 2>&1 | _filter_qemu_io | _filter_testdir
>  $QEMU_IMG convert -O $IMGFMT -c -B "$TEST_IMG".base -o backing_fmt=$IMGFMT \

I have seen that warning few times already in my scripts, so good to have this option.

Reviewed-by: Maxim Levitsky <mlevitsk@redhat.com>

Best regards,
	Maxim Levitsky





^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] qemu-img: Add -F shorthand to convert
  2021-09-13 13:17 [PATCH] qemu-img: Add -F shorthand to convert Eric Blake
  2021-09-15  8:20 ` Vladimir Sementsov-Ogievskiy
  2021-09-15  8:33 ` Maxim Levitsky
@ 2021-09-15 11:19 ` Hanna Reitz
  2021-09-17 20:13 ` Eric Blake
  3 siblings, 0 replies; 6+ messages in thread
From: Hanna Reitz @ 2021-09-15 11:19 UTC (permalink / raw)
  To: Eric Blake, qemu-devel; +Cc: Kevin Wolf, berrange, qemu-block

On 13.09.21 15:17, Eric Blake wrote:
> Although we have long supported 'qemu-img convert -o
> backing_file=foo,backing_fmt=bar', the fact that we have a shortcut -B
> for backing_file but none for backing_fmt has made it more likely that
> users accidentally run into:
>
> qemu-img: warning: Deprecated use of backing file without explicit backing format
>
> when using -B instead of -o.  For similarity with other qemu-img
> commands, such as create and compare, add '-F $fmt' as the shorthand
> for '-o backing_fmt=$fmt'.  Update iotest 122 for coverage of both
> spellings.
>
> Signed-off-by: Eric Blake <eblake@redhat.com>
> ---
>
> This stemmed from an IRC conversation; I'd add a Reported-by: line if
> I can figure out how to credit more than just the nick bparker_.

Thanks, applied to my block branch:

https://gitlab.com/hreitz/qemu/-/commits/block/

Hanna



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] qemu-img: Add -F shorthand to convert
  2021-09-13 13:17 [PATCH] qemu-img: Add -F shorthand to convert Eric Blake
                   ` (2 preceding siblings ...)
  2021-09-15 11:19 ` Hanna Reitz
@ 2021-09-17 20:13 ` Eric Blake
  2021-09-17 23:36   ` Vladimir Sementsov-Ogievskiy
  3 siblings, 1 reply; 6+ messages in thread
From: Eric Blake @ 2021-09-17 20:13 UTC (permalink / raw)
  To: qemu-devel; +Cc: Kevin Wolf, Hanna Reitz, berrange, qemu-block

On Mon, Sep 13, 2021 at 08:17:35AM -0500, Eric Blake wrote:
> Although we have long supported 'qemu-img convert -o
> backing_file=foo,backing_fmt=bar', the fact that we have a shortcut -B
> for backing_file but none for backing_fmt has made it more likely that
> users accidentally run into:
> 
> qemu-img: warning: Deprecated use of backing file without explicit backing format
> 
> when using -B instead of -o.  For similarity with other qemu-img
> commands, such as create and compare, add '-F $fmt' as the shorthand
> for '-o backing_fmt=$fmt'.  Update iotest 122 for coverage of both
> spellings.
> 
> Signed-off-by: Eric Blake <eblake@redhat.com>
> ---
>

Self-review (and late, too), but...

> +++ b/docs/tools/qemu-img.rst
> @@ -414,7 +414,7 @@ Command description:
>    4
>      Error on reading data
> 
> -.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
> +.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE [-F backing_fmt]] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME

s/backing_fmt/BACKING_FMT/ would be more consistent here

> +++ b/qemu-img-cmds.hx
> @@ -46,7 +46,7 @@ SRST
>  ERST
> 
>  DEF("convert", img_convert,
> -    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
> +    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file [-F backing_fmt]] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
>  SRST
>  .. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME

and I missed this line here. We have too much not-quite-identical
duplication :( Followup patch coming.

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org



^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH] qemu-img: Add -F shorthand to convert
  2021-09-17 20:13 ` Eric Blake
@ 2021-09-17 23:36   ` Vladimir Sementsov-Ogievskiy
  0 siblings, 0 replies; 6+ messages in thread
From: Vladimir Sementsov-Ogievskiy @ 2021-09-17 23:36 UTC (permalink / raw)
  To: Eric Blake, qemu-devel; +Cc: Kevin Wolf, Hanna Reitz, berrange, qemu-block

17.09.2021 23:13, Eric Blake wrote:
> On Mon, Sep 13, 2021 at 08:17:35AM -0500, Eric Blake wrote:
>> Although we have long supported 'qemu-img convert -o
>> backing_file=foo,backing_fmt=bar', the fact that we have a shortcut -B
>> for backing_file but none for backing_fmt has made it more likely that
>> users accidentally run into:
>>
>> qemu-img: warning: Deprecated use of backing file without explicit backing format
>>
>> when using -B instead of -o.  For similarity with other qemu-img
>> commands, such as create and compare, add '-F $fmt' as the shorthand
>> for '-o backing_fmt=$fmt'.  Update iotest 122 for coverage of both
>> spellings.
>>
>> Signed-off-by: Eric Blake <eblake@redhat.com>
>> ---
>>
> 
> Self-review (and late, too), but...
> 
>> +++ b/docs/tools/qemu-img.rst
>> @@ -414,7 +414,7 @@ Command description:
>>     4
>>       Error on reading data
>>
>> -.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
>> +.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps [--skip-broken-bitmaps]] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE [-F backing_fmt]] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
> 
> s/backing_fmt/BACKING_FMT/ would be more consistent here
> 
>> +++ b/qemu-img-cmds.hx
>> @@ -46,7 +46,7 @@ SRST
>>   ERST
>>
>>   DEF("convert", img_convert,
>> -    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
>> +    "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file [-F backing_fmt]] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
>>   SRST
>>   .. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
> 
> and I missed this line here. We have too much not-quite-identical
> duplication :( Followup patch coming.
> 

That's for sure accidental complexity :)

-- 
Best regards,
Vladimir


^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2021-09-17 23:37 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-13 13:17 [PATCH] qemu-img: Add -F shorthand to convert Eric Blake
2021-09-15  8:20 ` Vladimir Sementsov-Ogievskiy
2021-09-15  8:33 ` Maxim Levitsky
2021-09-15 11:19 ` Hanna Reitz
2021-09-17 20:13 ` Eric Blake
2021-09-17 23:36   ` Vladimir Sementsov-Ogievskiy

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.