mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-09-09 09:14:57 +00:00
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 <sbhat@linux.vnet.ibm.com>
This commit is contained in:
parent
8dbb347816
commit
e6806d7938
@ -313,7 +313,10 @@ virConnectGetSysinfo(virConnectPtr conn, unsigned int flags)
|
|||||||
*
|
*
|
||||||
* Provides the maximum number of virtual CPUs supported for a guest VM of a
|
* Provides the maximum number of virtual CPUs supported for a guest VM of a
|
||||||
* specific type. The 'type' parameter here corresponds to the 'type'
|
* 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. 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 "<vcpu max='...'>" in its output instead.
|
||||||
*
|
*
|
||||||
* Returns the maximum of virtual CPU or -1 in case of error.
|
* Returns the maximum of virtual CPU or -1 in case of error.
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user