diff mbox

[trivial] mention -b backing_file in qemu-img create subcommand

Message ID 20120916114108.2A4EA3400@gandalf.tls.msk.ru
State New
Headers show

Commit Message

Michael Tokarev Sept. 16, 2012, 11:41 a.m. UTC
The text describing `create' qemu-img subcommand refers to backing_file,
but it is not mentioned anywhere in the syntax for this subcommand.

Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>

Comments

Kevin Wolf Sept. 17, 2012, 8:27 a.m. UTC | #1
Am 16.09.2012 13:41, schrieb Michael Tokarev:
> The text describing `create' qemu-img subcommand refers to backing_file,
> but it is not mentioned anywhere in the syntax for this subcommand.
> 
> Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>

No, -b is deprecated, you should be using -o backing_file=...

What description exactly are you talking about, qemu-img.texi? It says:

> @item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
> 
> Create the new disk image @var{filename} of size @var{size} and format
> @var{fmt}. Depending on the file format, you can add one or more @var{options}
> that enable additional features of this format.
> 
> If the option @var{backing_file} is specified, then the image will record
> only the differences from @var{backing_file}.

Which for me seemed to be a pretty clear reference to -o
backing_file=..., but if it isn't, maybe we can rephrase it somehow.

Kevin
diff mbox

Patch

diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
index 39419a0..82c6e38 100644
--- a/qemu-img-cmds.hx
+++ b/qemu-img-cmds.hx
@@ -16,9 +16,9 @@  STEXI
 ETEXI
 
 DEF("create", img_create,
-    "create [-f fmt] [-o options] filename [size]")
+    "create [-f fmt] [-o options] [-b backing_file] filename [size]")
 STEXI
-@item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
+@item create [-f @var{fmt}] [-o @var{options}] [-b @var{backing_file}] @var{filename} [@var{size}]
 ETEXI
 
 DEF("commit", img_commit,
diff --git a/qemu-img.texi b/qemu-img.texi
index 6b42e35..4fbf2ed 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -92,7 +92,7 @@  wrong fix or hiding corruption that has already occured.
 Only the formats @code{qcow2}, @code{qed} and @code{vdi} support
 consistency checks.
 
-@item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
+@item create [-f @var{fmt}] [-o @var{options}] [-b @var{backing_file}] @var{filename} [@var{size}]
 
 Create the new disk image @var{filename} of size @var{size} and format
 @var{fmt}. Depending on the file format, you can add one or more @var{options}