diff options
| author |   Cole Robinson <crobinso@redhat.com> | 2010-02-22 15:52:14 -0500 |
|---|---|---|
| committer | Cole Robinson <crobinso@redhat.com> | 2010-02-23 09:44:38 -0500 |
| commit | 3a6555b3457477011df70366f3f1213025ef09e0 (patch) | |
| tree | adf4afc8f65b8582fdf17cf1412d214736f1890e /docs/formatstorage.html.in | |
| parent | storage: conf: Correctly calculate exabyte unit (diff) | |
| download | libvirt-3a6555b3457477011df70366f3f1213025ef09e0.tar.gz libvirt-3a6555b3457477011df70366f3f1213025ef09e0.tar.bz2 libvirt-3a6555b3457477011df70366f3f1213025ef09e0.zip | |
docs: storage: Document capacity/alloc 'unit'
Diffstat (limited to 'docs/formatstorage.html.in')
| -rw-r--r-- | docs/formatstorage.html.in | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in index 5c41c3982..6dbe0cab8 100644 --- a/docs/formatstorage.html.in +++ b/docs/formatstorage.html.in @@ -215,10 +215,18 @@ allocated at time of creation. If set to a value smaller than the capacity, the pool has the <strong>option</strong> of deciding to sparsely allocate a volume. It does not have to honour requests - for sparse allocation though. <span class="since">Since 0.4.1</span></dd> + for sparse allocation though.<br/> + <br/> + By default this is specified in bytes, but an optional + <code>unit</code> can be specified to adjust the passed value. + Values can be: 'K' (kilobytes), 'M' (megabytes), 'G' (gigabytes), + 'T' (terabytes), 'P' (petabytes), or 'E' (exabytes). + <span class="since">Since 0.4.1</span></dd> <dt><code>capacity</code></dt> <dd>Providing the logical capacity for the volume. This value is - in bytes. This is compulsory when creating a volume. + in bytes by default, but a <code>unit</code> attribute can be + specified with the same semantics as for <code>allocation</code> + This is compulsory when creating a volume. <span class="since">Since 0.4.1</span></dd> <dt><code>source</code></dt> <dd>Provides information about the underlying storage allocation |