mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qemu-img: print short help on getopt failure

Browse Source 
Printing the full help output obscures the error message for an invalid
command-line option or missing argument.

Before this patch:

  $ ./qemu-img --foo
  ...pages of output...

After this patch:

  $ ./qemu-img --foo
  qemu-img: unrecognized option '--foo'
  Try 'qemu-img --help' for more information

This patch adds the getopt ':' character so that it can distinguish
between missing arguments and unrecognized options.  This helps provide
more detailed error messages.

Suggested-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Message-id: 20170317104541.28979-4-stefanha@redhat.com
Reviewed-by: Max Reitz <mreitz@redhat.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
This commit is contained in:
Stefan Hajnoczi 2017-03-17 18:45:41 +08:00 committed by Max Reitz
parent f7077624b0
commit c919297379
1 changed files with 97 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
qemu-img.c
View File

@ -88,6 +88,16 @@ static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
exit(EXIT_FAILURE); exit(EXIT_FAILURE);
} }
static void QEMU_NORETURN missing_argument(const char *option)
{
error_exit("missing argument for option '%s'", option);
}
static void QEMU_NORETURN unrecognized_option(const char *option)
{
error_exit("unrecognized option '%s'", option);
}
/* Please keep in synch with qemu-img.texi */ /* Please keep in synch with qemu-img.texi */
static void QEMU_NORETURN help(void) static void QEMU_NORETURN help(void)
{ {
@ -406,13 +416,18 @@ static int img_create(int argc, char **argv)
{"object", required_argument, 0, OPTION_OBJECT}, {"object", required_argument, 0, OPTION_OBJECT},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "F:b:f:he6o:q", c = getopt_long(argc, argv, ":F:b:f:he6o:q",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -651,13 +666,18 @@ static int img_check(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "hf:r:T:q", c = getopt_long(argc, argv, ":hf:r:T:q",
long_options, &option_index); long_options, &option_index);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -855,13 +875,18 @@ static int img_commit(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "f:ht:b:dpq", c = getopt_long(argc, argv, ":f:ht:b:dpq",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -1190,13 +1215,18 @@ static int img_compare(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "hf:F:T:pqs", c = getopt_long(argc, argv, ":hf:F:T:pqs",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch (c) { switch (c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -1926,13 +1956,18 @@ static int img_convert(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qnm:W", c = getopt_long(argc, argv, ":hf:O:B:ce6o:s:l:S:pt:T:qnm:W",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -2502,13 +2537,18 @@ static int img_info(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "f:h", c = getopt_long(argc, argv, ":f:h",
long_options, &option_index); long_options, &option_index);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -2713,13 +2753,18 @@ static int img_map(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "f:h", c = getopt_long(argc, argv, ":f:h",
long_options, &option_index); long_options, &option_index);
if (c == -1) { if (c == -1) {
break; break;
} }
switch (c) { switch (c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -2835,13 +2880,18 @@ static int img_snapshot(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "la:c:d:hq", c = getopt_long(argc, argv, ":la:c:d:hq",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
return 0; return 0;
@ -2988,13 +3038,18 @@ static int img_rebase(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "hf:F:b:upt:T:q", c = getopt_long(argc, argv, ":hf:F:b:upt:T:q",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
return 0; return 0;
@ -3355,13 +3410,18 @@ static int img_resize(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "f:hq", c = getopt_long(argc, argv, ":f:hq",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch(c) { switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h': case 'h':
help(); help();
break; break;
@ -3493,15 +3553,20 @@ static int img_amend(int argc, char **argv)
{"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "ho:f:t:pq", c = getopt_long(argc, argv, ":ho:f:t:pq",
long_options, NULL); long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch (c) { switch (c) {
case 'h': case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h':
help(); help();
break; break;
case 'o': case 'o':
@ -3759,14 +3824,19 @@ static int img_bench(int argc, char **argv)
{"no-drain", no_argument, 0, OPTION_NO_DRAIN}, {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
{0, 0, 0, 0} {0, 0, 0, 0}
}; };
c = getopt_long(argc, argv, "hc:d:f:no:qs:S:t:w", long_options, NULL); c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:w", long_options, NULL);
if (c == -1) { if (c == -1) {
break; break;
} }
switch (c) { switch (c) {
case 'h': case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h':
help(); help();
break; break;
case 'c': case 'c':
@ -4093,7 +4163,7 @@ static int img_dd(int argc, char **argv)
{ 0, 0, 0, 0 } { 0, 0, 0, 0 }
}; };
while ((c = getopt_long(argc, argv, "hf:O:", long_options, NULL))) { while ((c = getopt_long(argc, argv, ":hf:O:", long_options, NULL))) {
if (c == EOF) { if (c == EOF) {
break; break;
} }
@ -4104,10 +4174,12 @@ static int img_dd(int argc, char **argv)
case 'f': case 'f':
fmt = optarg; fmt = optarg;
break; break;
case ':':
missing_argument(argv[optind - 1]);
break;
case '?': case '?':
error_report("Try 'qemu-img --help' for more information."); unrecognized_option(argv[optind - 1]);
ret = -1; break;
goto out;
case 'h': case 'h':
help(); help();
break; break;
@ -4336,10 +4408,15 @@ int main(int argc, char **argv)
qemu_add_opts(&qemu_source_opts); qemu_add_opts(&qemu_source_opts);
qemu_add_opts(&qemu_trace_opts); qemu_add_opts(&qemu_trace_opts);
while ((c = getopt_long(argc, argv, "+hVT:", long_options, NULL)) != -1) { while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
switch (c) { switch (c) {
case 'h': case ':':
missing_argument(argv[optind - 1]);
return 0;
case '?': case '?':
unrecognized_option(argv[optind - 1]);
return 0;
case 'h':
help(); help();
return 0; return 0;
case 'V': case 'V':