[libvirt] [PATCH 2/2] Add documentation for <disk><source type="dir">

[Eric Blake]

On 12/07/2011 09:55 AM, Christophe Fergeau wrote:
> ---
>  docs/formatdomain.html.in |   12 +++++++-----
>  1 files changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index 204373e..64aede5 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -1023,11 +1023,13 @@
>          path to the file holding the disk. If the disk
>          <code>type</code> is "block", then the <code>dev</code>
>          attribute specifies the path to the host device to serve as
> -        the disk. If the disk <code>type</code> is "network", then
> -        the <code>protocol</code> attribute specifies the protocol to
> -        access to the requested image; possible values are "nbd",
> -        "rbd", and "sheepdog".  If the <code>protocol</code> attribute
> -        is "rbd" or "sheepdog", an additional
> +        the disk. If the disk <code>type</code> is "dir", then the
> +        <code>dir</code> attribute specifies the fully-qualified path
> +        to the directory to use as the disk. If the disk <code>type</code>
> +        is "network", then the <code>protocol</code> attribute specifies
> +        the protocol to access to the requested image; possible values
> +        are "nbd", "rbd", and "sheepdog".  If the <code>protocol</code>
> +        attribute is "rbd" or "sheepdog", an additional
>          attribute <code>name</code> is mandatory to specify which
>          image to be used.  When the disk <code>type</code> is
>          "network", the <code>source</code> may have zero or

ACK to the idea, but I think we should have some "since 0.x.x"
notations.  I tweaked this before pushing:

diff --git i/docs/formatdomain.html.in w/docs/formatdomain.html.in
index 64aede5..22c73cd 100644
--- i/docs/formatdomain.html.in
+++ w/docs/formatdomain.html.in
@@ -1035,8 +1035,9 @@
         "network", the <code>source</code> may have zero or
         more <code>host</code> sub-elements used to specify the hosts
         to connect.
-        <span class="since">Since 0.0.3</span>
-        For "file" disk type which represents cdrom or floppy
+        <span class="since">Since 0.0.3; <code>type='dir'</code> since
+        0.7.5; <code>type='network'</code> since 0.8.7</span><br/>
+        For a "file" disk type which represents a cdrom or floppy
         (the <code>device</code> attribute) it is possible to define
         policy what to do with disk if source is not accessible.
         This is done by <code>startupPolicy</code> attribute accepting


-- 
Eric Blake   eblake at redhat.com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 620 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20111207/93e6b3fd/attachment-0001.sig>