From patchwork Mon Dec 17 13:39:53 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miroslav Rezanina X-Patchwork-Id: 206873 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id 233522C0080 for ; Tue, 18 Dec 2012 01:17:10 +1100 (EST) Received: from localhost ([::1]:56124 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TkbVD-0006ME-FW for incoming@patchwork.ozlabs.org; Mon, 17 Dec 2012 09:17:07 -0500 Received: from eggs.gnu.org ([208.118.235.92]:45255) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TkbUx-0006Js-IT for qemu-devel@nongnu.org; Mon, 17 Dec 2012 09:16:54 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1TkbUu-0007Wm-Rk for qemu-devel@nongnu.org; Mon, 17 Dec 2012 09:16:51 -0500 Received: from 212-4-128-36.cust.selfnet.cz ([212.4.128.36]:46974 helo=lws-ntb.brq.redhat.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1TkbUt-0007T3-E8 for qemu-devel@nongnu.org; Mon, 17 Dec 2012 09:16:48 -0500 Received: from lws-ntb.brq.redhat.com (localhost [127.0.0.1]) by lws-ntb.brq.redhat.com (8.14.5/8.14.5) with ESMTP id qBHDec0X031623; Mon, 17 Dec 2012 14:40:39 +0100 Received: (from root@localhost) by lws-ntb.brq.redhat.com (8.14.5/8.14.5/Submit) id qBHDeZpt031622; Mon, 17 Dec 2012 14:40:35 +0100 From: mrezanin@redhat.com To: qemu-devel@nongnu.org Date: Mon, 17 Dec 2012 14:39:53 +0100 Message-Id: <1355751593-31535-5-git-send-email-mrezanin@redhat.com> X-Mailer: git-send-email 1.7.11.7 In-Reply-To: <1355751593-31535-4-git-send-email-mrezanin@redhat.com> References: <1355751593-31535-1-git-send-email-mrezanin@redhat.com> <1355751593-31535-2-git-send-email-mrezanin@redhat.com> <1355751593-31535-3-git-send-email-mrezanin@redhat.com> <1355751593-31535-4-git-send-email-mrezanin@redhat.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 212.4.128.36 Cc: kwolf@redhat.com, pbonzini@redhat.com, Miroslav Rezanina , stefanha@redhat.com Subject: [Qemu-devel] [PATCH v7 4/4] Add qemu-img compare documentation X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org From: Miroslav Rezanina Adding documentation for new qemu-img subcommand compare. Signed-off-by: Miroslav Rezanina --- 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"; printf("%s\nSupported formats:", help_msg); bdrv_iterate_format(format_print, NULL); diff --git a/qemu-img.texi b/qemu-img.texi index bb82a3d..7eb1934 100644 --- a/qemu-img.texi +++ b/qemu-img.texi @@ -84,6 +84,18 @@ deletes a snapshot lists all snapshots in the given image @end table +Parameters to compare subcommand: + +@table @option + +@item -f +First image format +@item -F +Second image format +@item -s +Strict mode - fail on on different image size or sector allocation +@end table + Command description: @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. +@item 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. + +By default, images with different size are considered identical if the larger +image contains only unallocated and/or zeroed sectors in the area after the end +of the other image. In addition, if any sector is not allocated in one image +and contains only zero bytes in the second one, it is evaluated as equal. You +can use Strict mode by specifying the @var{-s} option. When compare runs in +Strict mode, it fails in case image size differs or a sector is allocated in +one image and is not allocated in the second one. + +By default, compare prints out a result message. This message displays +information that both images are same or the position of the first different +byte. In addition, result message can report different image size in case +Strict mode is used. + @item convert [-c] [-p] [-f @var{fmt}] [-t @var{cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_name}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename} Convert the disk image @var{filename} or a snapshot @var{snapshot_name} to disk image @var{output_filename}