docs: formatsnapshot: add docs for snapshotDeleteInProgress

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@gmail.com>
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>

diff --git a/docs/formatsnapshot.rst b/docs/formatsnapshot.rst
index 570a988442d6dc9bc934112e3902618f3e435db4..b85194b6bb1b000c73629a62914e0e2e3d17ab3b 100644 (file)
--- a/docs/formatsnapshot.rst
+++ b/docs/formatsnapshot.rst
@@ -170,6 +170,18 @@ 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``
+
+         This element is valid only in existing snapshot metadata XMLs and makes
+         no sense when creating a snapshot.
+
+         Presence of this element signifies that a deletion of a snapshot was
+         not completed yet and the disk images are in inconsistent state. User
+         needs to re-start any previous snapshot deletion to finish this process.
+
+         Users should not add or remove it as it can result in image corruption
+         on subsequent operations. :since:`Since 9.0`
+
 ``creationTime``
 
    A readonly representation of the time this snapshot was created. The time is