7a3408
From eb4814f8a769829820cf97f959fded8dc6e03cef Mon Sep 17 00:00:00 2001
7a3408
Message-Id: <eb4814f8a769829820cf97f959fded8dc6e03cef@dist-git>
7a3408
From: John Ferlan <jferlan@redhat.com>
7a3408
Date: Tue, 18 Aug 2015 14:47:14 -0400
7a3408
Subject: [PATCH] api: Adjust comment for virDomainAddIOThread
7a3408
7a3408
https://bugzilla.redhat.com/show_bug.cgi?id=1251886
7a3408
7a3408
The comment for the function indicated that iothread_id had to be
7a3408
a positive non-zero value; however, that wasn't checked - that is
7a3408
a value of 0 is/was allowed by the API and was left up to the
7a3408
hypervisor to reject the value.
7a3408
7a3408
More than likely this nuance was missed during the many "adjustments"
7a3408
to the API in the review phase.
7a3408
7a3408
(cherry picked from commit 53058e11aa1d5ba9e86153ed47e97c4988b5eef6)
7a3408
Signed-off-by: John Ferlan <jferlan@redhat.com>
7a3408
Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
7a3408
---
7a3408
 src/libvirt-domain.c | 6 +++---
7a3408
 1 file changed, 3 insertions(+), 3 deletions(-)
7a3408
7a3408
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
7a3408
index c4377bf..55ee28d 100644
7a3408
--- a/src/libvirt-domain.c
7a3408
+++ b/src/libvirt-domain.c
7a3408
@@ -7952,9 +7952,9 @@ virDomainPinIOThread(virDomainPtr domain,
7a3408
  * @iothread_id: the specific IOThread ID value to add
7a3408
  * @flags: bitwise-OR of virDomainModificationImpact
7a3408
  *
7a3408
- * Dynamically add an IOThread to the domain. If @iothread_id is a positive
7a3408
- * non-zero value, then attempt to add the specific IOThread ID and error
7a3408
- * out if the iothread id already exists.
7a3408
+ * Dynamically add an IOThread to the domain. It is left up to the
7a3408
+ * underlying virtual hypervisor to determine the valid range for an
7a3408
+ * @iothread_id and determining whether the @iothread_id already exists.
7a3408
  *
7a3408
  * Note that this call can fail if the underlying virtualization hypervisor
7a3408
  * does not support it or if growing the number is arbitrarily limited.
7a3408
-- 
7a3408
2.5.0
7a3408