Re: [Qemu-devel] [PATCH v2 3/3] qemu-img: Document backing options

[Eric Blake]

On 04/26/2017 08:46 AM, Max Reitz wrote:
> The create and convert subcommands have shorthands to set the
> backing_file and, in the case of create, the backing_fmt options for the
> new image. However, they have not been documented so far, which is
> remedied by this patch.
> 

> +++ b/qemu-img.texi
> @@ -224,7 +224,7 @@ If @code{-r} is specified, exit codes representing the 
> image state refer to the
>  state after (the attempt at) repairing it. That is, a successful @code{-r 
> all}
>  will yield the exit code 0, independently of the image state before.
>  
> address@hidden create [-f @var{fmt}] [-o @var{options}] @var{filename} 
> address@hidden
> address@hidden create [-f @var{fmt}] [-b @var{backing_file}] [-F 
> @var{backing_fmt}] [-o @var{options}] @var{filename} address@hidden
>  
>  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}
> @@ -302,7 +302,7 @@ Error on reading data
>  
>  @end table
>  
> address@hidden convert [-c] [-p] [-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}] [-m 
> @var{num_coroutines}] [-W] [-S @var{sparse_size}] @var{filename} 
> address@hidden [...]] @var{output_filename}
> address@hidden convert [-c] [-p] [-n] [-f @var{fmt}] [-t @var{cache}] [-T 
> @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o 
> @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-m 
> @var{num_coroutines}] [-W] [-S @var{sparse_size}] @var{filename} 
> address@hidden [...]] @var{output_filename}
>  
>  Convert the disk image @var{filename} or a snapshot 
> @var{snapshot_param}(@var{snapshot_id_or_name} is deprecated)
>  to disk image @var{output_filename} using format @var{output_fmt}. It can be 
> optionally compressed (@code{-c}


On 04/27/2017 10:25 AM, Kevin Wolf wrote:

> I think originally the idea was to remove the individual special case
> options in the long term in favour of the uniform -o. But I don't think
> the short options have fallen out of use, so we can as well document
> them again...
>
> Maybe we could change the implementation, however, so that the old
> options are really just aliases for the respective -o version.

As in, a followup patch that adds a paragraph or two to the .texi file
stating that '-B @var{backing_file}' is shorthand for '-o
address@hidden'?

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org

signature.asc
Description: OpenPGP digital signature