]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: document correct flag name
authorEric Blake <eblake@redhat.com>
Fri, 24 Jun 2011 15:02:39 +0000 (09:02 -0600)
committerEric Blake <eblake@redhat.com>
Fri, 24 Jun 2011 15:04:49 +0000 (09:04 -0600)
When adding virDomainGetVcpusFlags in commit ea3f5c6, I did
enough rebasing that the doc comments in libvirt.c no longer
matched the final chosen enum names in libvirt.h.

And now we've gone ahead and deprecated the names
VIR_DOMAIN_VCPU_{LIVE,CONFIG}.

* src/libvirt.c (virDomainGetVcpusFlags): Fix comment.

src/libvirt.c

index 26f338ee99b950652203ec6c87d43215a9793c4d..76e16ad49a7925f720921c81ccc915fbc312e920 100644 (file)
@@ -6919,9 +6919,9 @@ error:
  * not support it.  This function requires privileged access to the
  * hypervisor.
  *
- * @flags must include either VIR_DOMAIN_VCPU_ACTIVE to query a
+ * @flags must include either VIR_DOMAIN_AFFECT_LIVE to query a
  * running domain (which will fail if domain is not active), or
- * VIR_DOMAIN_VCPU_PERSISTENT to query the XML description of the
+ * VIR_DOMAIN_AFFECT_CONFIG to query the XML description of the
  * domain.  It is an error to set both flags.
  *
  * If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then the maximum