From e6806d793817fee19432173b1a69905b23dad31b Mon Sep 17 00:00:00 2001 From: Shivaprasad G Bhat Date: Fri, 24 Jun 2016 20:34:34 +0530 Subject: [PATCH] Document to not rely on virConnectGetMaxVcpus API The API virConnectGetMaxVcpus doesn't 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 --- src/libvirt-host.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/libvirt-host.c b/src/libvirt-host.c index 24277b71b7..2a3de03115 100644 --- a/src/libvirt-host.c +++ b/src/libvirt-host.c @@ -313,7 +313,10 @@ 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 element of the XML. + * attribute in the element of the XML. This API doesn't take emulator + * limits into consideration, hence the returned value is not guaranteed to be + * usable. It is recommended to use virConnectGetDomainCapabilities() and look + * for "" in its output instead. * * Returns the maximum of virtual CPU or -1 in case of error. */