From 2bcf14eabf02063fc7850a6b578f9bd6e26a6e60 Mon Sep 17 00:00:00 2001 From: Abhiram Tilak Date: Mon, 13 May 2024 20:37:53 +0530 Subject: [PATCH] docs: formatsnapshot: add docs for snapshotDeleteInProgress Adds documentation for the element to the libvirt snapshot format XML reference. The 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 Signed-off-by: Peter Krempa Reviewed-by: Peter Krempa --- docs/formatsnapshot.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/formatsnapshot.rst b/docs/formatsnapshot.rst index 570a988442..b85194b6bb 100644 --- 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