diff mbox

[v2,3/3] qemu-io: Extended "--cmd" description in usage text

Message ID 1395122359-28890-4-git-send-email-maria.k@catit.be
State New
Headers show

Commit Message

Maria Kustova March 18, 2014, 5:59 a.m. UTC 
It's not clear from the usage description that "--cmd" option accepts its argument as a string, so any special symbols have to be quoted from the shell.
Updates in usage text:
 - Specified parameter format for "--cmd" option.
 - Added an instruction how to get help for "--cmd" option.

Signed-off-by: Maria Kustova <maria.k@catit.be>
---
 qemu-io.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

Comments

Kevin Wolf March 18, 2014, 9:19 a.m. UTC | #1 
Am 18.03.2014 um 06:59 hat Maria Kustova geschrieben:
> It's not clear from the usage description that "--cmd" option accepts its argument as a string, so any special symbols have to be quoted from the shell.

For future patches, please make sure to wrap your lines in the commit
message at ideally ~72, but at most 80 characters. This instance I fixed
up while applying the patch.

Kevin

> Updates in usage text:
>  - Specified parameter format for "--cmd" option.
>  - Added an instruction how to get help for "--cmd" option.
> 
> Signed-off-by: Maria Kustova <maria.k@catit.be>
diff mbox

Patch

diff --git a/qemu-io.c b/qemu-io.c
index fc38608..be68d96 100644
--- a/qemu-io.c
+++ b/qemu-io.c
@@ -194,10 +194,11 @@  static const cmdinfo_t quit_cmd = {
 static void usage(const char *name)
 {
     printf(
-"Usage: %s [-h] [-V] [-rsnm] [-c cmd] ... [file]\n"
+"Usage: %s [-h] [-V] [-rsnm] [-c STRING] ... [file]\n"
 "QEMU Disk exerciser\n"
 "\n"
-"  -c, --cmd            command to execute\n"
+"  -c, --cmd STRING     execute command with its arguments\n"
+"                       from the given string\n"
 "  -r, --read-only      export read-only\n"
 "  -s, --snapshot       use snapshot file\n"
 "  -n, --nocache        disable host cache\n"
@@ -208,8 +209,10 @@  static void usage(const char *name)
 "  -T, --trace FILE     enable trace events listed in the given file\n"
 "  -h, --help           display this help and exit\n"
 "  -V, --version        output version information and exit\n"
+"\n"
+"See '%s -c help' for information on available commands."
 "\n",
-    name);
+    name, name);
 }
 
 static char *get_prompt(void)