From: Eric Blake <eblake@redhat.com>
Date: Tue, 26 Jun 2018 00:16:04 +0000 (-0500)
Subject: snapshots: Clarify comments on snapshot role
X-Git-Tag: v4.5.0-rc1~48
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0ec6343a069b21178d4580688a8380dbb6d76620;p=thirdparty%2Flibvirt.git

snapshots: Clarify comments on snapshot role

Give some more details on what a snapshot is good for, to make
it easier to distinguish from the role of upcoming additions for
incremental backups.

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: John Ferlan <jferlan@redhat.com>
---

diff --git a/include/libvirt/libvirt-domain-snapshot.h b/include/libvirt/libvirt-domain-snapshot.h
index 0f73f24b2b..20771f9b1e 100644
--- a/include/libvirt/libvirt-domain-snapshot.h
+++ b/include/libvirt/libvirt-domain-snapshot.h
@@ -31,15 +31,17 @@
 /**
  * virDomainSnapshot:
  *
- * a virDomainSnapshot is a private structure representing a snapshot of
- * a domain.
+ * A virDomainSnapshot is a private structure representing a snapshot of
+ * a domain.  A snapshot captures the state of the domain at a point in
+ * time, with the intent that the guest can be reverted back to that
+ * state at a later time.
  */
 typedef struct _virDomainSnapshot virDomainSnapshot;
 
 /**
  * virDomainSnapshotPtr:
  *
- * a virDomainSnapshotPtr is pointer to a virDomainSnapshot private structure,
+ * A virDomainSnapshotPtr is pointer to a virDomainSnapshot private structure,
  * and is the type used to reference a domain snapshot in the API.
  */
 typedef virDomainSnapshot *virDomainSnapshotPtr;