]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
snapshot: Documentation and comment improvements
authorEric Blake <eblake@redhat.com>
Fri, 12 Jul 2019 20:43:01 +0000 (15:43 -0500)
committerEric Blake <eblake@redhat.com>
Wed, 24 Jul 2019 22:03:34 +0000 (17:03 -0500)
Changes noticed while copying to similar aspects of checkpoints.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
docs/formatsnapshot.html.in
tests/virsh-snapshot

index 92cc5664675d8a18f287b67bcc32627196c6b9b0..005800bc005ede2c816144cf2bdf6683f76f330f 100644 (file)
         guest.
       </dd>
       <dt><code>parent</code></dt>
-      <dd>An optional readonly representation of the parent of this
-        snapshot.  If present, this element contains exactly one child
-        element, <code>name</code>.  This specifies the name of the
-        parent snapshot of this snapshot, and is used to represent
-        trees of snapshots.
+      <dd>Readonly, present only if this snapshot has a parent. The
+        parent name is given by the sub-element <code>name</code>. The
+        parent relationship allows tracking a tree of related snapshots.
       </dd>
       <dt><code>domain</code></dt>
       <dd>A readonly representation of the domain that this snapshot
index c31da52ef940810c5f26dfb67d921a4470b8817e..b23d949f620afc294805827702c0095fe700166e 100755 (executable)
@@ -85,7 +85,7 @@ $abs_top_builddir/tools/virsh --connect test:///default >out 2>err '
 # and snapshot-list produces timestamps
 sed 's/ *$//; s/[0-9-]\{10\} [0-9:.]* .[0-9]\{4\}/TIMESTAMP/;
    /MarkerA/,/MarkerC/d' < out > out.cooked || fail=1
-# Second part holds domain XMLs
+# Second part holds domain snapshot XMLs
 sed -n '/MarkerA/,/MarkerB/p' < out > s3.xml || fail=1
 sed -n '/MarkerB/,/MarkerC/p' < out > s2.xml || fail=1