mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2025-04-26 15:14:42 +00:00
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 currently rejected as unrecognized for hypervisors with no snapshot support at all. A later patch may teach more drivers to ignore the flag as a no-op, but that shouldn't conflict with the wording chosen here (since a new client talking to an old server still runs into the same issue, even if a newer server becomes more tolerant). Reported-by: Peter Krempa <pkrempa@redhat.com> Signed-off-by: Eric Blake <eblake@redhat.com> Acked-by: Peter Krempa <pkrempa@redhat.com>
This commit is contained in:
parent
4d91ad1c59
commit
c049f022f7
@ -6270,10 +6270,11 @@ virDomainUndefine(virDomainPtr domain)
|
|||||||
* virDomainSnapshotNum()), then including
|
* virDomainSnapshotNum()), then including
|
||||||
* VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA in @flags will also remove
|
* VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA in @flags will also remove
|
||||||
* that metadata. Omitting the flag will cause the undefine of an
|
* that metadata. Omitting the flag will cause the undefine of an
|
||||||
* inactive domain to fail. Active snapshots will retain snapshot
|
* inactive domain with snapshots to fail. Active domains will retain
|
||||||
* metadata until the (now-transient) domain halts, regardless of
|
* snapshot metadata until the (now-transient) domain halts,
|
||||||
* whether this flag is present. On hypervisors where snapshots do
|
* regardless of whether this flag is present. On hypervisors that
|
||||||
* not use libvirt metadata, this flag has no effect.
|
* 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
|
* If the domain has any nvram specified, the undefine process will fail
|
||||||
* unless VIR_DOMAIN_UNDEFINE_KEEP_NVRAM is specified, or if
|
* unless VIR_DOMAIN_UNDEFINE_KEEP_NVRAM is specified, or if
|
||||||
|
Loading…
x
Reference in New Issue
Block a user