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.
This commit is contained in:
John Ferlan 2014-07-23 08:36:50 -04:00
parent b983742029
commit b6938a7c88

View File

@ -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