yeahuh / rpms / qemu-kvm

Forked from rpms/qemu-kvm 2 years ago
Clone

Blame SOURCES/kvm-qemu-img-clarify-src_cache-option-documentation.patch

9ae3a8
From 94301da385eea27bfd9191cfc3f68b8df2e21987 Mon Sep 17 00:00:00 2001
9ae3a8
From: Max Reitz <mreitz@redhat.com>
9ae3a8
Date: Fri, 24 Oct 2014 08:17:59 +0200
9ae3a8
Subject: [PATCH 11/19] qemu-img: clarify src_cache option documentation
9ae3a8
9ae3a8
Message-id: <1414138680-19600-4-git-send-email-mreitz@redhat.com>
9ae3a8
Patchwork-id: 61864
9ae3a8
O-Subject: [RHEL-7.1 qemu-kvm PATCH v2 3/4] qemu-img: clarify src_cache option documentation
9ae3a8
Bugzilla: 1138691
9ae3a8
RH-Acked-by: Laszlo Ersek <lersek@redhat.com>
9ae3a8
RH-Acked-by: Markus Armbruster <armbru@redhat.com>
9ae3a8
RH-Acked-by: Kevin Wolf <kwolf@redhat.com>
9ae3a8
9ae3a8
From: Stefan Hajnoczi <stefanha@redhat.com>
9ae3a8
9ae3a8
The source cache option takes the same values as the cache option.  The
9ae3a8
documentation reads a little strange because it starts with "In contrast
9ae3a8
the src_cache option ...".  The fact that this is comparing with the
9ae3a8
previous documented option (the 'cache' option) is implicit.  Readers
9ae3a8
may be confused, especially if they jump to src_cache without reading
9ae3a8
cache documentation first.
9ae3a8
9ae3a8
Suggested-by: Jeff Nelson <jenelson@redhat.com>
9ae3a8
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
9ae3a8
Reviewed-by: Max Reitz <mreitz@redhat.com>
9ae3a8
(cherry picked from commit bb87fdf871d321895b8f5c481977df7a3f74a765)
9ae3a8
9ae3a8
Signed-off-by: Max Reitz <mreitz@redhat.com>
9ae3a8
Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>
9ae3a8
---
9ae3a8
 qemu-img.c    | 3 ++-
9ae3a8
 qemu-img.texi | 5 +++--
9ae3a8
 2 files changed, 5 insertions(+), 3 deletions(-)
9ae3a8
9ae3a8
diff --git a/qemu-img.c b/qemu-img.c
9ae3a8
index 1f28729..39d7e05 100644
9ae3a8
--- a/qemu-img.c
9ae3a8
+++ b/qemu-img.c
9ae3a8
@@ -84,7 +84,8 @@ static void help(void)
9ae3a8
            "  'cache' is the cache mode used to write the output disk image, the valid\n"
9ae3a8
            "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
9ae3a8
            "    'directsync' and 'unsafe' (default for convert)\n"
9ae3a8
-           "  'src_cache' in contrast is the cache mode used to read input disk images\n"
9ae3a8
+           "  'src_cache' is the cache mode used to read input disk images, the valid\n"
9ae3a8
+           "    options are the same as for the 'cache' option\n"
9ae3a8
            "  'size' is the disk image size in bytes. Optional suffixes\n"
9ae3a8
            "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M)\n"
9ae3a8
            "    and T (terabyte, 1024G) are supported. 'b' is ignored.\n"
9ae3a8
diff --git a/qemu-img.texi b/qemu-img.texi
9ae3a8
index 078fe81..4b7a331 100644
9ae3a8
--- a/qemu-img.texi
9ae3a8
+++ b/qemu-img.texi
9ae3a8
@@ -69,8 +69,9 @@ specifies the cache mode that should be used with the (destination) file. See
9ae3a8
 the documentation of the emulator's @code{-drive cache=...} option for allowed
9ae3a8
 values.
9ae3a8
 @item -T @var{src_cache}
9ae3a8
-in contrast specifies the cache mode that should be used with the source
9ae3a8
-file(s).
9ae3a8
+specifies the cache mode that should be used with the source file(s). See
9ae3a8
+the documentation of the emulator's @code{-drive cache=...} option for allowed
9ae3a8
+values.
9ae3a8
 @end table
9ae3a8
 
9ae3a8
 Parameters to snapshot subcommand:
9ae3a8
-- 
9ae3a8
1.8.3.1
9ae3a8