]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
doc: storage: Explicitly state that it's possible to have non-unique key
authorPeter Krempa <pkrempa@redhat.com>
Mon, 3 Mar 2014 15:39:40 +0000 (16:39 +0100)
committerPeter Krempa <pkrempa@redhat.com>
Wed, 5 Mar 2014 08:51:24 +0000 (09:51 +0100)
With most of our storage backends it's possible to have two separate
volume keys to point to a single volume. (By creating sym/hard-links to
local files or by mounting remote filesystems to two different locations
and creating pools on top of them) Document this possibility.

docs/formatstorage.html.in

index a089a3108b4a2cdb2b8745ac25a84d68aaf0caf4..1cd82b4565a99f69be0cb876df13558191e7e340 100644 (file)
       <dd>Providing a name for the volume which is unique to the pool.
         This is mandatory when defining a volume.  <span class="since">Since 0.4.1</span></dd>
       <dt><code>key</code></dt>
-      <dd>Providing an identifier for the volume which is globally unique.
-          This cannot be set when creating a volume: it is always generated.
+      <dd>Providing an identifier for the volume which identifies a
+          single volume. In some cases it's possible to have two distinct keys
+          identifying a single volume. This field cannot be set when creating
+          a volume: it is always generated.
         <span class="since">Since 0.4.1</span></dd>
       <dt><code>allocation</code></dt>
       <dd>Providing the total storage allocation for the volume. This