cryptospore / rpms / qemu-kvm

Forked from rpms/qemu-kvm 2 years ago
Clone

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

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