docs: document correct flag name

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.
This commit is contained in:
Eric Blake 2011-06-24 09:02:39 -06:00
parent 1aa859d633
commit db323e3b97

View 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