]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
libvirt: document UNDEFINE_KEEP_NVRAM in UndefineFlags docs
authorCole Robinson <crobinso@redhat.com>
Mon, 6 Mar 2017 22:54:40 +0000 (17:54 -0500)
committerCole Robinson <crobinso@redhat.com>
Tue, 7 Mar 2017 15:58:25 +0000 (10:58 -0500)
src/libvirt-domain.c

index 619a9fccb2ca7ed8708730b3e64f151adaaa07b2..749297f214515c22fec243819b76de64303c94dc 100644 (file)
@@ -6287,9 +6287,9 @@ virDomainUndefine(virDomainPtr domain)
  * whether this flag is present.  On hypervisors where snapshots do
  * not use libvirt metadata, this flag has no effect.
  *
- * If the domain has any nvram specified, then including
- * VIR_DOMAIN_UNDEFINE_NVRAM will also remove that file, and omitting the flag
- * will cause the undefine process to fail.
+ * If the domain has any nvram specified, the undefine process will fail
+ * unless VIR_DOMAIN_UNDEFINE_KEEP_NVRAM is specified, or if
+ * VIR_DOMAIN_UNDEFINE_NVRAM is specified to remove the nvram file.
  *
  * Returns 0 in case of success, -1 in case of error
  */