[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-block] [PATCH 2/5] qemu-img.texi: fix command ordering
From: |
Jeff Cody |
Subject: |
Re: [Qemu-block] [PATCH 2/5] qemu-img.texi: fix command ordering |
Date: |
Tue, 8 May 2018 11:33:45 -0400 |
User-agent: |
Mutt/1.5.24 (2015-08-30) |
On Thu, May 03, 2018 at 06:56:45PM -0400, John Snow wrote:
> This should match the summary ordering, which is alphabetical.
>
> Signed-off-by: John Snow <address@hidden>
> ---
Reviewed-by: Jeff Cody <address@hidden>
> qemu-img.texi | 58 ++++++++++++++++++++++++++++++----------------------------
> 1 file changed, 30 insertions(+), 28 deletions(-)
>
> diff --git a/qemu-img.texi b/qemu-img.texi
> index 8a26400adb..adf5176902 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -193,6 +193,12 @@ sets the number of input blocks to skip
> Command description:
>
> @table @option
> +
> address@hidden amend [-p] [-f @var{fmt}] [-t @var{cache}] -o @var{options}
> @var{filename}
> +
> +Amends the image format specific @var{options} for the image file
> address@hidden Not all file formats support this operation.
> +
> @item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}] address@hidden
> [-n] [--no-drain] [-o @var{offset}] address@hidden [-q] [-s
> @var{buffer_size}] [-S @var{step_size}] [-t @var{cache}] [-w] @var{filename}
>
> Run a simple sequential I/O benchmark on the specified image. If @code{-w} is
> @@ -253,30 +259,6 @@ 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}] [-b @var{backing_file}] [-F
> @var{backing_fmt}] [-u] [-o @var{options}] @var{filename} address@hidden
> -
> -Create the new disk image @var{filename} of size @var{size} and format
> address@hidden Depending on the file format, you can add one or more
> @var{options}
> -that enable additional features of this format.
> -
> -If the option @var{backing_file} is specified, then the image will record
> -only the differences from @var{backing_file}. No size needs to be specified
> in
> -this case. @var{backing_file} will never be modified unless you use the
> address@hidden monitor command (or qemu-img commit).
> -
> -If a relative path name is given, the backing file is looked up relative to
> -the directory containing @var{filename}.
> -
> -Note that a given backing file will be opened to check that it is valid. Use
> -the @code{-u} option to enable unsafe backing file mode, which means that the
> -image will be created even if the associated backing file cannot be opened. A
> -matching backing file must be created or additional options be used to make
> the
> -backing file specification valid when you want to use an image created this
> -way.
> -
> -The size can also be specified using the @var{size} option with @code{-o},
> -it doesn't need to be specified separately in this case.
> -
> @item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p]
> @var{filename}
>
> Commit the changes recorded in @var{filename} in its base image or backing
> file.
> @@ -381,6 +363,30 @@ creating compressed images.
> @var{num_coroutines} specifies how many coroutines work in parallel during
> the convert process (defaults to 8).
>
> address@hidden create [-f @var{fmt}] [-b @var{backing_file}] [-F
> @var{backing_fmt}] [-u] [-o @var{options}] @var{filename} address@hidden
> +
> +Create the new disk image @var{filename} of size @var{size} and format
> address@hidden Depending on the file format, you can add one or more
> @var{options}
> +that enable additional features of this format.
> +
> +If the option @var{backing_file} is specified, then the image will record
> +only the differences from @var{backing_file}. No size needs to be specified
> in
> +this case. @var{backing_file} will never be modified unless you use the
> address@hidden monitor command (or qemu-img commit).
> +
> +If a relative path name is given, the backing file is looked up relative to
> +the directory containing @var{filename}.
> +
> +Note that a given backing file will be opened to check that it is valid. Use
> +the @code{-u} option to enable unsafe backing file mode, which means that the
> +image will be created even if the associated backing file cannot be opened. A
> +matching backing file must be created or additional options be used to make
> the
> +backing file specification valid when you want to use an image created this
> +way.
> +
> +The size can also be specified using the @var{size} option with @code{-o},
> +it doesn't need to be specified separately in this case.
> +
> @item dd [-f @var{fmt}] [-O @var{output_fmt}] address@hidden address@hidden
> address@hidden address@hidden address@hidden
>
> Dd copies from @var{input} file to @var{output} file converting it from
> @@ -585,10 +591,6 @@ how the additional image area should be allocated on the
> host. See the format
> description in the @code{NOTES} section which values are allowed. Using this
> option may result in slightly more data being allocated than necessary.
>
> address@hidden amend [-p] [-f @var{fmt}] [-t @var{cache}] -o @var{options}
> @var{filename}
> -
> -Amends the image format specific @var{options} for the image file
> address@hidden Not all file formats support this operation.
> @end table
> @c man end
>
> --
> 2.14.3
>
>
- [Qemu-block] [PATCH 0/5] qemu-img: make subcommand usage docstrings consistent, John Snow, 2018/05/03
- [Qemu-block] [PATCH 1/5] qemu-img-commands.hx: argument ordering fixups, John Snow, 2018/05/03
- [Qemu-block] [PATCH 2/5] qemu-img.texi: fix command ordering, John Snow, 2018/05/03
- Re: [Qemu-block] [PATCH 2/5] qemu-img.texi: fix command ordering,
Jeff Cody <=
- [Qemu-block] [PATCH 5/5] qemu-img-cmds.hx: add passive-aggressive note, John Snow, 2018/05/03
- [Qemu-block] [PATCH 3/5] qemu-img: remove references to GEN_DOCS, John Snow, 2018/05/03
- [Qemu-block] [PATCH 4/5] qemu-img: Make documentation between .texi and .hx consistent, John Snow, 2018/05/03
- Re: [Qemu-block] [PATCH 0/5] qemu-img: make subcommand usage docstrings consistent, John Snow, 2018/05/03