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>
---
Changes in v2:
  - Insert a note to advise users against adding or removing the internal tag
  "snapshotDeleteInProgress" manually.

 docs/formatsnapshot.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/docs/formatsnapshot.rst b/docs/formatsnapshot.rst
index 570a988442..f802a8e227 100644
--- a/docs/formatsnapshot.rst
+++ b/docs/formatsnapshot.rst
@@ -170,6 +170,15 @@ 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. This
+         element is typically generated by the snapshot-create API and should
+         not be manually added or removed.
+         :since:`Since 9.0`
+
 ``creationTime``

    A readonly representation of the time this snapshot was created. The time is
--
2.44.0
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org

On Mon, May 13, 2024 at 20:37:53 +0530, Abhiram Tilak wrote:
> 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>
> ---
> Changes in v2:
>   - Insert a note to advise users against adding or removing the internal tag
>   "snapshotDeleteInProgress" manually.

I've reworded the docs a bit further and pushed this patch.

Reviewed-by: Peter Krempa <pkrempa@redhat.com>

Alright. I will check it out.

On Wed, 15 May 2024 at 12:03, Peter Krempa <pkrempa@redhat.com> wrote:

> On Mon, May 13, 2024 at 20:37:53 +0530, Abhiram Tilak wrote:
> > 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>
> > ---
> > Changes in v2:
> >   - Insert a note to advise users against adding or removing the
> internal tag
> >   "snapshotDeleteInProgress" manually.
>
> I've reworded the docs a bit further and pushed this patch.
>
> Reviewed-by: Peter Krempa <pkrempa@redhat.com>
>
>

-- 
Abhiram