From: John Ferlan <jferlan@redhat.com>
Date: Sat, 3 Dec 2016 12:53:15 +0000 (-0500)
Subject: docs: Update formatstorage to match code for pool path
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=7ed89d7421f8a1af619ffa09644eb8837ac71212;p=libvirt.git

docs: Update formatstorage to match code for pool path

Seems commit id '0257d06b' forgot to include formatstorage when updating
the docs to describe allowing zfs as a pool type and to furthermore note
that the pool's target path element will be generated rather than read.

Similarly commit id 'efab27afb' neglected to indicate that the target path
for a logical pool will now be generated by libvirt.

Signed-off-by: John Ferlan <jferlan@redhat.com>
---

diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in
index f1be511dcd..47c8b0c8a7 100644
--- a/docs/formatstorage.html.in
+++ b/docs/formatstorage.html.in
@@ -380,8 +380,8 @@
       <code>pool</code> element for some types of pools (pool
       types <code>dir</code>, <code>fs</code>, <code>netfs</code>,
       <code>logical</code>, <code>disk</code>, <code>iscsi</code>,
-      <code>scsi</code>, <code>mpath</code>). This tag is used to
-      describe the mapping of
+      <code>scsi</code>, <code>mpath</code>, <code>zfs</code>).
+      This tag is used to describe the mapping of
       the storage pool into the host filesystem. It can contain the following
       child elements:
     </p>
@@ -411,6 +411,8 @@
         guaranteed stable across reboots, since they are allocated on
         demand. It is preferable to use a stable location such as one
         of the <code>/dev/disk/by-{path|id|uuid|label}</code> locations.
+        For <code>logical</code> and <code>zfs</code> pool types, a
+        provided value is ignored and a default path generated.
         For a Multipath pool (type <code>mpath</code>), the provided
         value is ignored and the default value of "/dev/mapper" is used.
         <span class="since">Since 0.4.1</span>