From 3fbdec4eee43aec8501e0e2cb93133b477d4b354 Mon Sep 17 00:00:00 2001
Message-Id: <3fbdec4eee43aec8501e0e2cb93133b477d4b354@dist-git>
From: Peter Krempa <pkrempa@redhat.com>
Date: Thu, 20 Jun 2019 17:45:01 +0200
Subject: [PATCH] docs: snapshot: Encourage people ot use disk 'target' to
 refer to disks

Change the example and add a recommendation to use disk target rather
than path.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
(cherry picked from commit c79ef73c37b1f91d38745cb1197026e702ce42fe)
https: //bugzilla.redhat.com/show_bug.cgi?id=1584682
Message-Id: <bdb8fa41c605bdda49eaf0436f8dc74992c54bd1.1561045343.git.pkrempa@redhat.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
---
 docs/formatsnapshot.html.in | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/formatsnapshot.html.in b/docs/formatsnapshot.html.in
index fbbecfd242..23f20d7c33 100644
--- a/docs/formatsnapshot.html.in
+++ b/docs/formatsnapshot.html.in
@@ -143,8 +143,8 @@
           <dd>This sub-element describes the snapshot properties of a
             specific disk.  The attribute <code>name</code> is
             mandatory, and must match either the <code>&lt;target
-            dev='name'/&gt;</code> or an unambiguous <code>&lt;source
-            file='name'/&gt;</code> of one of
+            dev='name'/&gt;</code> (recommended) or an unambiguous
+            <code>&lt;source file='name'/&gt;</code> of one of
             the <a href="formatdomain.html#elementsDisks">disk
             devices</a> specified for the domain at the time of the
             snapshot.  The attribute <code>snapshot</code> is
@@ -251,7 +251,7 @@
 &lt;domainsnapshot&gt;
   &lt;description&gt;Snapshot of OS install and updates&lt;/description&gt;
   &lt;disks&gt;
-    &lt;disk name='/path/to/old'&gt;
+    &lt;disk name='vda'&gt;
       &lt;source file='/path/to/new'/&gt;
     &lt;/disk&gt;
     &lt;disk name='vdb' snapshot='no'/&gt;
-- 
2.22.1