]> xenbits.xensource.com Git - people/liuw/libxenctrl-split/libvirt.git/commitdiff
libvirt: Document UNDEFINE_NVRAM in UndefineFlags doc
authorCole Robinson <crobinso@redhat.com>
Tue, 14 Oct 2014 09:27:33 +0000 (11:27 +0200)
committerCole Robinson <crobinso@redhat.com>
Wed, 15 Oct 2014 08:16:13 +0000 (10:16 +0200)
src/libvirt.c

index caacc2ebf397ed6d739559fc311fe7e1c3c2269b..dfca4f6da3e201c6efe3d337fe24ba3be8202ff4 100644 (file)
@@ -8760,6 +8760,10 @@ 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.
+ *
  * Returns 0 in case of success, -1 in case of error
  */
 int