openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Abhiram Tilak 2024-05-13 20:37:53 +05:30 committed by Peter Krempa
parent 16e7a61292
commit 2bcf14eabf
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/formatsnapshot.rst
View File

@ -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