[Qemu-devel] [PATCH v8 08/36] qemu-img: Update documentation of "-L" option

[Fam Zheng]

Signed-off-by: Fam Zheng <address@hidden>
---
 qemu-img-cmds.hx | 44 ++++++++++++++++++++++----------------------
 qemu-img.c       |  1 +
 qemu-img.texi    |  3 +++
 3 files changed, 26 insertions(+), 22 deletions(-)

diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
index f054599..eaca454 100644
--- a/qemu-img-cmds.hx
+++ b/qemu-img-cmds.hx
@@ -16,33 +16,33 @@ STEXI
 ETEXI
 
 DEF("check", img_check,
-    "check [-q] [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] 
[-r [leaks | all]] [-T src_cache] filename")
+    "check [-q] [-L] [--object objectdef] [--image-opts] [-f fmt] 
[--output=ofmt] [-r [leaks | all]] [-T src_cache] filename")
 STEXI
address@hidden check [--object @var{objectdef}] [--image-opts] [-q] [-f 
@var{fmt}] address@hidden [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
address@hidden check [--object @var{objectdef}] [--image-opts] [-q] [-L] [-f 
@var{fmt}] address@hidden [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
 ETEXI
 
 DEF("create", img_create,
-    "create [-q] [--object objectdef] [--image-opts] [-f fmt] [-o options] 
filename [size]")
+    "create [-q] [-L] [--object objectdef] [--image-opts] [-f fmt] [-o 
options] filename [size]")
 STEXI
address@hidden create [--object @var{objectdef}] [--image-opts] [-q] [-f 
@var{fmt}] [-o @var{options}] @var{filename} address@hidden
address@hidden create [--object @var{objectdef}] [--image-opts] [-q] [-L] [-f 
@var{fmt}] [-o @var{options}] @var{filename} address@hidden
 ETEXI
 
 DEF("commit", img_commit,
-    "commit [-q] [--object objectdef] [--image-opts] [-f fmt] [-t cache] [-b 
base] [-d] [-p] filename")
+    "commit [-q] [-L] [--object objectdef] [--image-opts] [-f fmt] [-t cache] 
[-b base] [-d] [-p] filename")
 STEXI
address@hidden commit [--object @var{objectdef}] [--image-opts] [-q] [-f 
@var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
address@hidden commit [--object @var{objectdef}] [--image-opts] [-q] [-L] [-f 
@var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
 ETEXI
 
 DEF("compare", img_compare,
-    "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T 
src_cache] [-p] [-q] [-s] filename1 filename2")
+    "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T 
src_cache] [-p] [-q] [-L] [-s] filename1 filename2")
 STEXI
address@hidden compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] 
[-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} 
@var{filename2}
address@hidden compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] 
[-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-L] [-s] @var{filename1} 
@var{filename2}
 ETEXI
 
 DEF("convert", img_convert,
-    "convert [--object objectdef] [--image-opts] [-c] [-p] [-q] [-n] [-f fmt] 
[-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] 
[-l snapshot_param] [-S sparse_size] filename [filename2 [...]] 
output_filename")
+    "convert [--object objectdef] [--image-opts] [-c] [-p] [-q] [-L] [-n] [-f 
fmt] [-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s 
snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] filename [filename2 
[...]] output_filename")
 STEXI
address@hidden convert [--object @var{objectdef}] [--image-opts] [-c] [-p] [-q] 
[-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] 
[-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S 
@var{sparse_size}] @var{filename} address@hidden [...]] @var{output_filename}
address@hidden convert [--object @var{objectdef}] [--image-opts] [-c] [-p] [-q] 
[-L] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O 
@var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l 
@var{snapshot_param}] [-S @var{sparse_size}] @var{filename} address@hidden 
[...]] @var{output_filename}
 ETEXI
 
 DEF("dd", img_dd,
@@ -52,38 +52,38 @@ STEXI
 ETEXI
 
 DEF("info", img_info,
-    "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] 
[--backing-chain] filename")
+    "info [--object objectdef] [--image-opts] [-f fmt] [-L] [--output=ofmt] 
[--backing-chain] filename")
 STEXI
address@hidden info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] 
address@hidden [--backing-chain] @var{filename}
address@hidden info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] 
[-L] address@hidden [--backing-chain] @var{filename}
 ETEXI
 
 DEF("map", img_map,
-    "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] 
filename")
+    "map [--object objectdef] [--image-opts] [-f fmt] [-L] [--output=ofmt] 
filename")
 STEXI
address@hidden map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] 
address@hidden @var{filename}
address@hidden map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] 
[-L] address@hidden @var{filename}
 ETEXI
 
 DEF("snapshot", img_snapshot,
-    "snapshot [--object objectdef] [--image-opts] [-q] [-l | -a snapshot | -c 
snapshot | -d snapshot] filename")
+    "snapshot [--object objectdef] [--image-opts] [-q] [-L] [-l | -a snapshot 
| -c snapshot | -d snapshot] filename")
 STEXI
address@hidden snapshot [--object @var{objectdef}] [--image-opts] [-q] [-l | -a 
@var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
address@hidden snapshot [--object @var{objectdef}] [--image-opts] [-q] [-L] [-l 
| -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
 ETEXI
 
 DEF("rebase", img_rebase,
-    "rebase [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-T 
src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
+    "rebase [--object objectdef] [--image-opts] [-q] [-L] [-f fmt] [-t cache] 
[-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
 STEXI
address@hidden rebase [--object @var{objectdef}] [--image-opts] [-q] [-f 
@var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b 
@var{backing_file} [-F @var{backing_fmt}] @var{filename}
address@hidden rebase [--object @var{objectdef}] [--image-opts] [-q] [-L] [-f 
@var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b 
@var{backing_file} [-F @var{backing_fmt}] @var{filename}
 ETEXI
 
 DEF("resize", img_resize,
-    "resize [--object objectdef] [--image-opts] [-q] filename [+ | -]size")
+    "resize [--object objectdef] [--image-opts] [-q] [-L] filename [+ | 
-]size")
 STEXI
address@hidden resize [--object @var{objectdef}] [--image-opts] [-q] 
@var{filename} [+ | address@hidden
address@hidden resize [--object @var{objectdef}] [--image-opts] [-q] [-L] 
@var{filename} [+ | address@hidden
 ETEXI
 
 DEF("amend", img_amend,
-    "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] 
-o options filename")
+    "amend [--object objectdef] [--image-opts] [-p] [-q] [-L] [-f fmt] [-t 
cache] -o options filename")
 STEXI
address@hidden amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-f 
@var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
address@hidden amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-L] 
[-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
 @end table
 ETEXI
diff --git a/qemu-img.c b/qemu-img.c
index e8d0e78..36b0af5 100644
--- a/qemu-img.c
+++ b/qemu-img.c
@@ -141,6 +141,7 @@ static void QEMU_NORETURN help(void)
            "  '-h' with or without a command shows this help and lists the 
supported formats\n"
            "  '-p' show progress of command (only certain commands)\n"
            "  '-q' use Quiet mode - do not print any output (except errors)\n"
+           "  '-L' don't lock the image\n"
            "  '-S' indicates the consecutive number of bytes (defaults to 4k) 
that must\n"
            "       contain only zeros for qemu-img to create a sparse image 
during\n"
            "       conversion. If the number of bytes is 0, the source will 
not be scanned for\n"
diff --git a/qemu-img.texi b/qemu-img.texi
index 174aae3..300ccf8 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -88,6 +88,9 @@ progress is reported when the process receives a 
@code{SIGUSR1} signal.
 @item -q
 Quiet mode - do not print any output (except errors). There's no progress bar
 in case both @var{-q} and @var{-p} options are used.
address@hidden -L
+disables image locking. The image will not be locked, other processes can
+access and lock this image while we are using it.
 @item -S @var{size}
 indicates the consecutive number of bytes that must contain only zeros
 for qemu-img to create a sparse image during conversion. This value is rounded
-- 
2.7.4