mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-08-27 19:11:16 +00:00
api: Adjust comment for virDomainAddIOThread
The comment for the function indicated that iothread_id had to be a positive non-zero value; however, that wasn't checked - that is a value of 0 is/was allowed by the API and was left up to the hypervisor to reject the value. More than likely this nuance was missed during the many "adjustments" to the API in the review phase.
This commit is contained in:
parent
d64b81a8f0
commit
53058e11aa
@ -7952,9 +7952,9 @@ virDomainPinIOThread(virDomainPtr domain,
|
|||||||
* @iothread_id: the specific IOThread ID value to add
|
* @iothread_id: the specific IOThread ID value to add
|
||||||
* @flags: bitwise-OR of virDomainModificationImpact
|
* @flags: bitwise-OR of virDomainModificationImpact
|
||||||
*
|
*
|
||||||
* Dynamically add an IOThread to the domain. If @iothread_id is a positive
|
* Dynamically add an IOThread to the domain. It is left up to the
|
||||||
* non-zero value, then attempt to add the specific IOThread ID and error
|
* underlying virtual hypervisor to determine the valid range for an
|
||||||
* out if the iothread id already exists.
|
* @iothread_id and determining whether the @iothread_id already exists.
|
||||||
*
|
*
|
||||||
* Note that this call can fail if the underlying virtualization hypervisor
|
* Note that this call can fail if the underlying virtualization hypervisor
|
||||||
* does not support it or if growing the number is arbitrarily limited.
|
* does not support it or if growing the number is arbitrarily limited.
|
||||||
|
Loading…
Reference in New Issue
Block a user