[libvirt] [PATCH 2/8] snapshot: Fix virDomainUndefineFlags docs regarding snapshots
The docs talked about an active snapshot when they meant an active
domain; they also claimed the flag was a no-op for hypervisors with no
snapshot metadata even though the flag is rejected as unrecognized for
hypervisors with no snapshot support at all.
Reported-by: Peter Krempa <pkrempa(a)redhat.com>
Signed-off-by: Eric Blake <eblake(a)redhat.com>
---
src/libvirt-domain.c | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index e2594a3392..3d12e7c125 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -6270,10 +6270,11 @@ virDomainUndefine(virDomainPtr domain)
* virDomainSnapshotNum()), then including
* VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA in @flags will also remove
* that metadata. Omitting the flag will cause the undefine of an
- * inactive domain to fail. Active snapshots will retain snapshot
- * metadata until the (now-transient) domain halts, regardless of
- * whether this flag is present. On hypervisors where snapshots do
- * not use libvirt metadata, this flag has no effect.
+ * inactive domain with snapshots to fail. Active domains will retain
+ * snapshot metadata until the (now-transient) domain halts,
+ * regardless of whether this flag is present. On hypervisors that
+ * support snapshots, but where snapshots do not use libvirt metadata,
+ * this flag has no effect.
*
* If the domain has any nvram specified, the undefine process will fail
* unless VIR_DOMAIN_UNDEFINE_KEEP_NVRAM is specified, or if
--
2.20.1