[libvirt] [PATCH 1/4] Document to not rely on virConnectGetMaxVcpus API

The API virConnectGetMaxVcpus doesnt really reflect the actual usable number of cpus as the maximum limits can be different for kvm and/or qemu. So update the documentation to use virConnectGetDomainCapabilities() instead. Signed-off-by: Shivaprasad G Bhat <sbhat(a)linux.vnet.ibm.com&gt; --- src/libvirt-host.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/libvirt-host.c b/src/libvirt-host.c index 24277b7..f6b0c30 100644 --- a/src/libvirt-host.c +++ b/src/libvirt-host.c @@ -313,7 +313,11 @@ virConnectGetSysinfo(virConnectPtr conn, unsigned int flags) * * Provides the maximum number of virtual CPUs supported for a guest VM of a * specific type. The 'type' parameter here corresponds to the 'type' - * attribute in the <domain> element of the XML. + * attribute in the <domain> element of the XML. The API doesn't take emulator + * limits into consideration. Hence the maximum reported here can be limited by + * the emulator max limits. It is recommended to use the + * virConnectGetDomainCapabilities() API specifying the emulator details to get + * the accurate results. * * Returns the maximum of virtual CPU or -1 in case of error. */