From: John Ferlan <jferlan@redhat.com>
Date: Wed, 23 Jul 2014 12:36:50 +0000 (-0400)
Subject: docs: Point to list of valid pool target volume formats
X-Git-Tag: v1.2.7-rc1~35
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b6938a7c880168b2b0bbb3f45b566b3d2318d49c;p=thirdparty%2Flibvirt.git

docs: Point to list of valid pool target volume formats

https://bugzilla.redhat.com/show_bug.cgi?id=1092886

Rather than point off to some nefarious "pool-specific docs" page when
describing the "format" field for the target pool provide a link to the
storage driver page which describes the various valid formats for each
pool type.  Also make it a bit more clear that if a valid format isn't
specified, then the type field is ignored.
---

diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in
index e26498543a..e25bba70f9 100644
--- a/docs/formatstorage.html.in
+++ b/docs/formatstorage.html.in
@@ -508,8 +508,12 @@
         or directory pools it will provide the file format type, eg cow,
         qcow, vmdk, raw. If omitted when creating a volume, the pool's
         default format will be used. The actual format is specified via
-        the <code>type</code> attribute. Consult the pool-specific docs for
-        the list of valid values. <span class="since">Since 0.4.1</span></dd>
+        the <code>type</code> attribute. Consult the
+        <a href="storage.html">storage driver page</a> for the list of valid
+        volume format type values for each specific pool. The
+        <code>format</code> will be ignored on input for pools without a
+        volume format type value and the default pool format will be used.
+        <span class="since">Since 0.4.1</span></dd>
       <dt><code>permissions</code></dt>
       <dd>Provides information about the default permissions to use
         when creating volumes. This is currently only useful for directory