[libvirt] [PATCH] doc: Fix doc for backingStore

[Eric Blake]

On 03/18/2015 03:47 AM, Deepak Shetty wrote:
> I spent quite some time figuring that backingStore info
> isn't included in the dom xml, unless guest is up and
> running. Hopefully putting that in the doc should help.
> 
> This patch adds that info to the doc.
> 
> Signed-off-by: Deepak C Shetty <deepakcs at redhat.com>
> ---
>  docs/formatdomain.html.in | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index ab51982..dfd4f3a 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -2113,7 +2113,9 @@
>          and only used for output to describe the detected backing chains.
>          <span class="since">Since 1.2.4</span>. An empty
>          <code>backingStore</code> element means the sibling source is
> -        self-contained and is not based on any backing store. The following
> +        self-contained and is not based on any backing store. Note that
> +        <code>backingStore</code> info is included in the output only when
> +        the guest is up and running, otherwise its not included. The

s/its/it's/

> following

We aim to fix that in the future (that is, eventually libvirt will track
backing information even for offline domains), but until that happens, I
can agree with documenting the limitation.  I will touch this up and
push it later today.

-- 
Eric Blake   eblake 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: 604 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20150318/711eeb90/attachment-0001.sig>