[libvirt] [PATCH] Website documentation for the snapshot XML.

Mon Apr 5 17:37:50 UTC 2010

Signed-off-by: Chris Lalancette <clalance at redhat.com>
---
 docs/formatsnapshot.html.in |   72 +++++++++++++++++++++++++++++++++++++++++++
 docs/sitemap.html.in        |    4 ++
 2 files changed, 76 insertions(+), 0 deletions(-)
 create mode 100644 docs/formatsnapshot.html.in

diff --git a/docs/formatsnapshot.html.in b/docs/formatsnapshot.html.in
new file mode 100644
index 0000000..fa007ea
--- /dev/null
+++ b/docs/formatsnapshot.html.in
@@ -0,0 +1,72 @@
+<html>
+  <body>
+    <h1>Snapshot XML format</h1>
+
+    <ul id="toc"></ul>
+
+    <h2><a name="SnapshotAttributes">Snapshot XML</a></h2>
+
+    <p>
+      Attributes of libvirt snapshots are stored as child elements of
+      the <code>domainsnapshot</code> element.  At snapshot creation
+      time, only the <code>name</code> and <code>description</code>
+      elements are settable; the rest of the fields are informational
+      (and readonly) and will be filled in by libvirt when the
+      snapshot is created.
+    </p>
+    <p>
+      The top-level <code>domainsnapshot</code> element may contain
+      the following elements:
+    </p>
+    <dl>
+      <dt><code>name</code></dt>
+      <dd>The name for this snapshot.  If the name is specified when
+      initially creating the snapshot, then the snapshot will have
+      that particular name.  If the name is omitted when initially
+      creating the snapshot, then libvirt will make up a name for the snapshot.
+      </dd>
+      <dt><code>description</code></dt>
+      <dd>A human-readable description of the snapshot.  If the
+        description is omitted when initially creating the snapshot,
+        then this field will be empty.
+      </dd>
+      <dt><code>creationTime</code></dt>
+      <dd>The time this snapshot was created.  The time is specified
+      in seconds since the Epoch (i.e. Unix time).  Readonly.
+      </dd>
+      <dt><code>state</code></dt>
+      <dd>The state of the domain at the time this snapshot was
+      taken.  When the domain is reverted to this snapshot, the domain's state
+      will be set to whatever is in this field.  Readonly.
+      </dd>
+      <dt><code>parent</code></dt>
+      <dd>The parent of this snapshot.  This element contains exactly
+      one child element, name.  This specifies the name of the parent
+      snapshot of this snapshot, and is used to represent trees of
+      snapshots.  Readonly.
+      </dd>
+      <dt><code>domain</code></dt>
+      <dd>The domain that this snapshot was taken against.  This
+      element contains exactly one child element, uuid.  This
+      specifies the uuid of the domain that this snapshot was taken
+      against.  Readonly.
+      </dd>
+    </dl>
+
+    <h2><a name="example">Example</a></h2>
+
+    <pre>
+      <domainsnapshot>
+         <name>os-updates</name>
+         <description>Snapshot of OS install and updates</description>
+         <state>running</state>
+         <creationTime>1270477159</creationTime>
+         <parent>
+            <name>bare-os-install</name>
+         </parent>
+         <domain>
+            <uuid>93a5c045-6457-2c09-e56c-927cdf34e178</uuid>
+         </domain>
+      </domainsnapshot></pre>
+  </body>
+</html>
diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in
index 76d8faa..ae2bfde 100644
--- a/docs/sitemap.html.in
+++ b/docs/sitemap.html.in
@@ -114,6 +114,10 @@
                 <a href="formatsecret.html">Secrets</a>
                 <span>The secret XML format</span>
               </li>
+              <li>
+                <a href="formatsnapshot.html">Secrets</a>
+                <span>The snapshot XML format</span>
+              </li>
             </ul>
           </li>
           <li>
-- 
1.6.6.1


