[libvirt PATCH 29/30] api: document support for external snapshot deletion

Pavel Hrdina posted 30 patches 3 years, 2 months ago
There is a newer version of this series
[libvirt PATCH 29/30] api: document support for external snapshot deletion
Posted by Pavel Hrdina 3 years, 2 months ago
Now that deletion of external snapshot is implemented document the
current virDomainSnapshotDelete supported state.

Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
---
 src/libvirt-domain-snapshot.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/libvirt-domain-snapshot.c b/src/libvirt-domain-snapshot.c
index 2917b8bd90..ab6a029915 100644
--- a/src/libvirt-domain-snapshot.c
+++ b/src/libvirt-domain-snapshot.c
@@ -1075,6 +1075,13 @@ virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
  * libvirt metadata to track snapshots, then this flag is silently
  * ignored.
  *
+ * Since libvirt 9.0.0 deletion of external snapshots is supported
+ * for QEMU driver. Using @flags VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN
+ * and VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY is not supported with
+ * external snapshots. In case that daemon process is terminated
+ * while the snapshot delete is in process the operation will be
+ * aborted when the daemon starts again.
+ *
  * Returns 0 if the selected snapshot(s) were successfully deleted,
  * -1 on error.
  *
-- 
2.38.1
Re: [libvirt PATCH 29/30] api: document support for external snapshot deletion
Posted by Peter Krempa 3 years, 1 month ago
On Thu, Dec 08, 2022 at 14:31:05 +0100, Pavel Hrdina wrote:
> Now that deletion of external snapshot is implemented document the
> current virDomainSnapshotDelete supported state.
> 
> Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
> ---
>  src/libvirt-domain-snapshot.c | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/src/libvirt-domain-snapshot.c b/src/libvirt-domain-snapshot.c
> index 2917b8bd90..ab6a029915 100644
> --- a/src/libvirt-domain-snapshot.c
> +++ b/src/libvirt-domain-snapshot.c
> @@ -1075,6 +1075,13 @@ virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
>   * libvirt metadata to track snapshots, then this flag is silently
>   * ignored.
>   *
> + * Since libvirt 9.0.0 deletion of external snapshots is supported
> + * for QEMU driver. Using @flags VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN
> + * and VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY is not supported with
> + * external snapshots. In case that daemon process is terminated
> + * while the snapshot delete is in process the operation will be
> + * aborted when the daemon starts again.
> + *

This doesn't look like the best place for this kind of documentation but
I don't have a better suggestion.

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