From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:54247) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XOeAi-0003Zr-DB for qemu-devel@nongnu.org; Mon, 01 Sep 2014 22:50:22 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XOeAc-0007Zy-86 for qemu-devel@nongnu.org; Mon, 01 Sep 2014 22:50:16 -0400 Received: from mx1.redhat.com ([209.132.183.28]:53001) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XOeAc-0007ZL-17 for qemu-devel@nongnu.org; Mon, 01 Sep 2014 22:50:10 -0400 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id s822o8Bc024342 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL) for ; Mon, 1 Sep 2014 22:50:08 -0400 Date: Tue, 2 Sep 2014 10:50:06 +0800 From: Fam Zheng Message-ID: <20140902025006.GA5586@T430.redhat.com> References: <1409584287-21844-1-git-send-email-stefanha@redhat.com> <1409584287-21844-2-git-send-email-stefanha@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1409584287-21844-2-git-send-email-stefanha@redhat.com> Subject: Re: [Qemu-devel] [PATCH 1/2] qemu-img: clarify src_cache option documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Stefan Hajnoczi Cc: Kevin Wolf , jenelson@redhat.com, qemu-devel@nongnu.org, Max Reitz On Mon, 09/01 16:11, Stefan Hajnoczi wrote: > The source cache option takes the same values as the cache option. The > documentation reads a little strange because it starts with "In contrast > the src_cache option ...". The fact that this is comparing with the > previous documented option (the 'cache' option) is implicit. Readers > may be confused, especially if they jump to src_cache without reading > cache documentation first. > > Suggested-by: Jeff Nelson > Signed-off-by: Stefan Hajnoczi > --- > qemu-img.c | 3 ++- > qemu-img.texi | 5 +++-- > 2 files changed, 5 insertions(+), 3 deletions(-) > > diff --git a/qemu-img.c b/qemu-img.c > index ff29ed1..91d1ac3 100644 > --- a/qemu-img.c > +++ b/qemu-img.c > @@ -95,7 +95,8 @@ static void QEMU_NORETURN help(void) > " 'cache' is the cache mode used to write the output disk image, the valid\n" > " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n" > " 'directsync' and 'unsafe' (default for convert)\n" > - " 'src_cache' in contrast is the cache mode used to read input disk images\n" > + " 'src_cache' is the cache mode used to read input disk images, the valid\n" > + " options are the same as for the 'cache' option\n" > " 'size' is the disk image size in bytes. Optional suffixes\n" > " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n" > " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n" > diff --git a/qemu-img.texi b/qemu-img.texi > index cb68948..4380d56 100644 > --- a/qemu-img.texi > +++ b/qemu-img.texi > @@ -73,8 +73,9 @@ specifies the cache mode that should be used with the (destination) file. See > the documentation of the emulator's @code{-drive cache=...} option for allowed > values. > @item -T @var{src_cache} > -in contrast specifies the cache mode that should be used with the source > -file(s). > +specifies the cache mode that should be used with the source file(s). See > +the documentation of the emulator's @code{-drive cache=...} option for allowed > +values. > @end table > > Parameters to snapshot subcommand: > -- > 1.9.3 > > Reviewed-by: Fam Zheng