]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: Point to list of valid pool target volume formats
authorJohn Ferlan <jferlan@redhat.com>
Wed, 23 Jul 2014 12:36:50 +0000 (08:36 -0400)
committerJohn Ferlan <jferlan@redhat.com>
Wed, 23 Jul 2014 15:05:56 +0000 (11:05 -0400)
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.

docs/formatstorage.html.in

index e26498543a94deb3102ec7539403edc801ec925b..e25bba70f95a903d0ab83f33514057f68c7c306c 100644 (file)
         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