Re: [Qemu-devel] [PATCH v7 4/4] Add qemu-img compare documentation

[Eric Blake]

On 12/17/2012 06:39 AM, address@hidden wrote:
> From: Miroslav Rezanina <address@hidden>
> 
> Adding documentation for new qemu-img subcommand compare.
> 
> Signed-off-by: Miroslav Rezanina <address@hidden>
> ---
>  qemu-img.c    |  7 ++++++-
>  qemu-img.texi | 32 ++++++++++++++++++++++++++++++++
>  2 files changed, 38 insertions(+), 1 deletion(-)
> 
> diff --git a/qemu-img.c b/qemu-img.c
> index 8b4f01f..a185e9e 100644
> --- a/qemu-img.c
> +++ b/qemu-img.c
> @@ -103,7 +103,12 @@ static void help(void)
>             "  '-a' applies a snapshot (revert disk to saved state)\n"
>             "  '-c' creates a snapshot\n"
>             "  '-d' deletes a snapshot\n"
> -           "  '-l' lists all snapshots in the given image\n";
> +           "  '-l' lists all snapshots in the given image\n"
> +           "\n"
> +           "Parameters to compare subcommand:\n"
> +           "  '-f' First image format\n"
> +           "  '-F' Second image format\n"
> +           "  '-s' Strict mode - fail on different image size or sector 
> allocation\n";

s/First/first/; s/Second/second/; s/Strict/strict/ for consistent
appearance of starting description with lower case

>  @table @option
> @@ -117,6 +129,26 @@ it doesn't need to be specified separately in this case.
>  
>  Commit the changes recorded in @var{filename} in its base image.
>  
> address@hidden compare [-f @var{fmt}] [-F @var{fmt}] [-p] [-s] [-q] 
> @var{filename1} @var{filename2}
> +
> +Check if two images have the same content. You can compare images with
> +different format or settings.
> +
> +The format is probed unless you specify it by @var{-f} (used for 
> @var{filename1}) and/or @var{-F} (used for @var{filename2}) option.

Wrap this long line.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature