fridtjof/qemu-cr16
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

qemu-img: create: refresh options/--help (short option change)

Browse source 
Create helper function cmd_help() to display command-specific
help text, and use it to print --help for 'create' subcommand.

Add missing long options (eg --format) in img_create().

Recognize -B option for --backing-format, keep -F for
backward compatibility,

Reorder options for consistency.

Remove usage of missing_argument()/unrecognized_option() in
img_create().

Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
Message-ID: <20250531171609.197078-6-mjt@tls.msk.ru>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
This commit is contained in:
Michael Tokarev 2025-05-31 20:15:47 +03:00 • committed by Kevin Wolf
parent 80415af893
commit 52292ba8b6
2 changed files with 73 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/tools/qemu-img.rst
View file

@ -467,11 +467,11 @@ Command description:
``--skip-broken-bitmaps`` is also specified to copy only the
consistent bitmaps.
.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F BACKING_FMT]] [-u] [-o OPTIONS] FILENAME [SIZE]
.. option:: create [-f FMT] [-o FMT_OPTS] [-b BACKING_FILE [-B BACKING_FMT]] [-u] [-q] [--object OBJDEF] FILE [SIZE]
Create the new disk image *FILENAME* of size *SIZE* and format
*FMT*. Depending on the file format, you can add one or more *OPTIONS*
that enable additional features of this format.
Create the new disk image *FILE* of size *SIZE* and format
*FMT*. Depending on the file format, you can add one or more *FMT_OPTS*
options that enable additional features of this format.
If the option *BACKING_FILE* is specified, then the image will record
only the differences from *BACKING_FILE*. No size needs to be specified in
@ -479,7 +479,7 @@ Command description:
``commit`` monitor command (or ``qemu-img commit``).
If a relative path name is given, the backing file is looked up relative to
the directory containing *FILENAME*.
the directory containing *FILE*.
Note that a given backing file will be opened to check that it is valid. Use
the ``-u`` option to enable unsafe backing file mode, which means that the

84
qemu-img.c
View file

@ -132,6 +132,32 @@ void unrecognized_option(const char *option)
error_exit("qemu-img", "unrecognized option '%s'", option);
}
/*
* Print --help output for a command and exit.
* @syntax and @description are multi-line with trailing EOL
* (to allow easy extending of the text)
* @syntax has each subsequent line indented by 8 chars.
* @description is indented by 2 chars for argument on each own line,
* and with 5 chars for argument description (like -h arg below).
*/
static G_NORETURN
void cmd_help(const img_cmd_t *ccmd,
const char *syntax, const char *arguments)
{
printf(
"Usage:\n"
"\n"
" %s %s %s"
"\n"
"Arguments:\n"
" -h, --help\n"
" print this help and exit\n"
"%s\n",
"qemu-img", ccmd->name,
syntax, arguments);
exit(EXIT_SUCCESS);
}
/* Please keep in synch with docs/tools/qemu-img.rst */
static G_NORETURN
void help(void)
@ -530,29 +556,46 @@ static int img_create(const img_cmd_t *ccmd, int argc, char **argv)
for(;;) {
static const struct option long_options[] = {
{"help", no_argument, 0, 'h'},
{"format", required_argument, 0, 'f'},
{"options", required_argument, 0, 'o'},
{"backing", required_argument, 0, 'b'},
{"backing-format", required_argument, 0, 'B'}, /* was -F in 10.0 */
{"backing-unsafe", no_argument, 0, 'u'},
{"quiet", no_argument, 0, 'q'},
{"object", required_argument, 0, OPTION_OBJECT},
{0, 0, 0, 0}
};
c = getopt_long(argc, argv, ":F:b:f:ho:qu",
c = getopt_long(argc, argv, "hf:o:b:F:B:uq",
long_options, NULL);
if (c == -1) {
break;
}
switch(c) {
case ':':
missing_argument(argv[optind - 1]);
break;
case '?':
unrecognized_option(argv[optind - 1]);
break;
case 'h':
help();
break;
case 'F':
base_fmt = optarg;
break;
case 'b':
base_filename = optarg;
cmd_help(ccmd, "[-f FMT] [-o FMT_OPTS]\n"
" [-b BACKING_FILE [-B BACKING_FMT]] [-u]\n"
" [-q] [--object OBJDEF] FILE [SIZE]\n"
,
" -f, --format FMT\n"
" specifies the format of the new image (default: raw)\n"
" -o, --options FMT_OPTS\n"
" format-specific options (specify '-o help' for help)\n"
" -b, --backing BACKING_FILE\n"
" create target image to be a CoW on top of BACKING_FILE\n"
" -B, --backing-format BACKING_FMT (was -F in <= 10.0)\n"
" specifies the format of BACKING_FILE (default: probing is used)\n"
" -u, --backing-unsafe\n"
" do not fail if BACKING_FILE can not be read\n"
" -q, --quiet\n"
" quiet mode (produce only error messages if any)\n"
" --object OBJDEF\n"
" defines QEMU user-creatable object\n"
" FILE\n"
" name of the image file to create (will be overritten if already exists)\n"
" SIZE[bKMGTPE]\n"
" image size with optional multiplier suffix (powers of 1024)\n"
" (required unless BACKING_FILE is specified)\n"
);
break;
case 'f':
fmt = optarg;
@ -562,15 +605,24 @@ static int img_create(const img_cmd_t *ccmd, int argc, char **argv)
goto fail;
}
break;
case 'q':
quiet = true;
case 'b':
base_filename = optarg;
break;
case 'F': /* <=10.0 */
case 'B':
base_fmt = optarg;
break;
case 'u':
flags |= BDRV_O_NO_BACKING;
break;
case 'q':
quiet = true;
break;
case OPTION_OBJECT:
user_creatable_process_cmdline(optarg);
break;
default:
tryhelp(argv[0]);
}
}