render / rpms / libvirt

Forked from rpms/libvirt 9 months ago
Clone
c1c534
From 60643d072a849ffbb01e8313124154f7aecc02ad Mon Sep 17 00:00:00 2001
c1c534
Message-Id: <60643d072a849ffbb01e8313124154f7aecc02ad@dist-git>
c1c534
From: Peter Krempa <pkrempa@redhat.com>
c1c534
Date: Thu, 7 Dec 2017 14:36:06 +0100
c1c534
Subject: [PATCH] docs: domain: Fix documentation of the 'snapshot' attribute
c1c534
 for <disk>
c1c534
c1c534
Emphasise the valid values by wrapping them in  and reword the
c1c534
last sentence so that the invalid value example can be dropped.
c1c534
c1c534
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1523070
c1c534
(cherry picked from commit 1e98d450f27ae0131ac2ac8aa1c1d7a254d22dd1)
c1c534
Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
c1c534
---
c1c534
 docs/formatdomain.html.in | 19 +++++++++----------
c1c534
 1 file changed, 9 insertions(+), 10 deletions(-)
c1c534
c1c534
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
c1c534
index 6807da5c6f..0cfbf051b7 100644
c1c534
--- a/docs/formatdomain.html.in
c1c534
+++ b/docs/formatdomain.html.in
c1c534
@@ -2573,17 +2573,16 @@
c1c534
           
snapshot
c1c534
             
c1c534
             Indicates the default behavior of the disk during disk snapshots:
c1c534
-            "internal" requires a file format such as qcow2 that can store
c1c534
-            both the snapshot and the data changes since the snapshot;
c1c534
-            "external" will separate the snapshot from the live data; and
c1c534
-            "no" means the disk will not participate in snapshots. Read-only
c1c534
-            disks default to "no", while the default for other disks depends
c1c534
-            on the hypervisor's capabilities.  Some hypervisors allow a
c1c534
-            per-snapshot choice as well, during
c1c534
+            "internal" requires a file format such as qcow2 that
c1c534
+            can store both the snapshot and the data changes since the snapshot;
c1c534
+            "external" will separate the snapshot from the live
c1c534
+            data; and "no" means the disk will not participate in
c1c534
+            snapshots. Read-only disks default to "no", while the
c1c534
+            default for other disks depends on the hypervisor's capabilities.
c1c534
+            Some hypervisors allow a per-snapshot choice as well, during
c1c534
             domain snapshot creation.
c1c534
-            Not all snapshot modes are supported; for example,
c1c534
-            snapshot='yes' with a transient disk generally
c1c534
-            does not make sense.
c1c534
+            Not all snapshot modes are supported; for example, enabling
c1c534
+            snapshots with a transient disk generally does not make sense.
c1c534
             Since 0.9.5
c1c534
             
c1c534
         
c1c534
-- 
c1c534
2.15.1
c1c534