diff --git a/docs/formatsnapshot.html.in b/docs/formatsnapshot.html.in index 79ed1d234a49f4a920c049278537c78557d9b1eb..dc5873a8225e4de9a33562c38e506ebc05017ef1 100644 --- a/docs/formatsnapshot.html.in +++ b/docs/formatsnapshot.html.in @@ -9,10 +9,26 @@
Attributes of libvirt snapshots are stored as child elements of
the domainsnapshot
element. At snapshot creation
- time, only the name
and description
- elements are settable; the rest of the fields are informational
- (and readonly) and will be filled in by libvirt when the
- snapshot is created.
+ time, normally only the name
+ and description
elements are settable; the rest of
+ the fields are ignored on creation, and will be filled in by
+ libvirt in for informational purposes
+ by virDomainSnapshotGetXMLDesc()
. However, when
+ redefining a snapshot (since 0.9.5),
+ with the VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE
flag
+ of virDomainSnapshotCreateXML()
, all of the XML
+ described here is relevant.
+
+ Snapshots are maintained in a hierarchy. A domain can have a + current snapshot, which is the most recent snapshot compared to + the current state of the domain (although a domain might have + snapshots without a current snapshot, if snapshots have been + deleted in the meantime). Creating or reverting to a snapshot + sets that snapshot as current, and the prior current snapshot is + the parent of the new snapshot. Branches in the hierarchy can + be formed by reverting to a snapshot with a child, then creating + another snapshot.
The top-level domainsnapshot
element may contain
@@ -21,9 +37,10 @@
name
description
creationTime
state
parent
domain
- <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>+<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>