diff mbox

libvirt: document UNDEFINE_KEEP_NVRAM in UndefineFlags docs

Message ID d05f77df08b0ac7189bf669f5fef0529e8d3a56c.1488842205.git.crobinso@redhat.com
State Accepted
Commit ee42957bb17319d070af5e07a4fc04d9ffa63b84
Headers show

Commit Message

Cole Robinson March 6, 2017, 11:16 p.m. UTC 
---
 src/libvirt-domain.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

-- 
2.9.3

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Comments

Pavel Hrdina March 7, 2017, 8:33 a.m. UTC | #1 
On Mon, Mar 06, 2017 at 06:16:45PM -0500, Cole Robinson wrote:
> ---

>  src/libvirt-domain.c | 6 +++---

>  1 file changed, 3 insertions(+), 3 deletions(-)

> 

> diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c

> index 619a9fc..749297f 100644

> --- a/src/libvirt-domain.c

> +++ b/src/libvirt-domain.c

> @@ -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

>   */


ACK

Pavel
--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
diff mbox

Patch

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 619a9fc..749297f 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -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
  */