[PATCH v2] doc: Fix doc for backingStore

[Deepak Shetty <dpkshetty@xxxxxxxxx>]

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@xxxxxxxxxx>
---
 docs/formatdomain.html.in | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index ab51982..a41c2c6 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -2113,7 +2113,12 @@
         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 it's not included. For accurate
+        <code>backingStore</code> info, when using external snapshot with the
+        destination of a existing file, the snapshot must be created with
+        backing file format specified in the metadata. The following
         attributes and sub-elements are supported in
         <code>backingStore</code>:
         <dl>
--
1.9.3

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list