Adds documentation for the <snapshotDeleteInProgress/> element to
the libvirt snapshot format XML reference. The <snapshotDeleteInProgress/>
element, introduced at commit 565bcb5d79, ensures the consistency of qcow2
images during snapshot deletion operations by marking disks in snapshot
metadata as invalid until deletion is successfully completed.
The commit was merged but the related documentation was missing.
Resolves:
https://gitlab.com/libvirt/libvirt/-/issues/609
Signed-off-by: Abhiram Tilak <atp.exp(a)gmail.com>
---
docs/formatsnapshot.rst | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/docs/formatsnapshot.rst b/docs/formatsnapshot.rst
index 570a988442..e3d0d47e00 100644
--- a/docs/formatsnapshot.rst
+++ b/docs/formatsnapshot.rst
@@ -170,6 +170,13 @@ The top-level ``domainsnapshot`` element may contain the following
elements:
sub-element can be used with same semantics as the identically named
subelement of the domain definition disk's driver.
+ ``snapshotDeleteInProgress``
+
+ If a the snapshot is marked for deletion, the disk is invalidated. The
+ sub-element ``snapshotDeleteInProgress`` marks the disk in the snapshot
+ as invalid until the snapshot delete is completed successfully.
+ :since:`Since 9.0`
+
``creationTime``
A readonly representation of the time this snapshot was created. The time is
--
2.44.0