When introducing VIR_DOMAIN_IOTHREAD_THREAD_POOL_MIN and
VIR_DOMAIN_IOTHREAD_THREAD_POOL_MAX typed parameters, I've made a
shortcut. Since at the monitor level these two are set in two
separate calls and minimum has to be always smaller than maximum
(or equal to it), it may happen that one of the values we want to
set violates this restriction. So I've put a little note in the
public API description warning users about this.

However, the proper solution is to have a logic that checks the
current values and based on that set either minimum or maximum
value first. But until we get there, remove that note from the
public API before it gets released.

Related: https://gitlab.com/libvirt/libvirt/-/issues/339
Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
---
 include/libvirt/libvirt-domain.h | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)

diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 05344aaa95..7430a08619 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -2513,9 +2513,7 @@ int                  virDomainDelIOThread(virDomainPtr domain,
  *
  * Sets the lower bound for thread pool size. A value of -1 disables this bound
  * leaving hypervisor use its default value, though this value is not accepted
- * for running domains. Due to internal implementation it's recommended to set
- * VIR_DOMAIN_IOTHREAD_THREAD_POOL_MIN and VIR_DOMAIN_IOTHREAD_THREAD_POOL_MAX
- * separately. Accepted type is VIR_TYPED_PARAM_INT.
+ * for running domains. Accepted type is VIR_TYPED_PARAM_INT.
  *
  * Since: 8.5.0
  */
@@ -2527,9 +2525,7 @@ int                  virDomainDelIOThread(virDomainPtr domain,
  * Sets the upper bound for thread pool size. A value of -1 disables this bound
  * leaving hypervisor use its default value, though this value is not accepted
  * for running domains. Since the upper band has to be equal to or greater than
- * lower bound value of 0 is not accepted. Due to internal implementation it's
- * recommended to set VIR_DOMAIN_IOTHREAD_THREAD_POOL_MIN and
- * VIR_DOMAIN_IOTHREAD_THREAD_POOL_MAX separately. Accepted type is
+ * lower bound value of 0 is not accepted. Accepted type is
  * VIR_TYPED_PARAM_INT.
  *
  * Since: 8.5.0
-- 
2.35.1

On Thu, Jun 30, 2022 at 08:40:21AM +0200, Michal Privoznik wrote:
> When introducing VIR_DOMAIN_IOTHREAD_THREAD_POOL_MIN and
> VIR_DOMAIN_IOTHREAD_THREAD_POOL_MAX typed parameters, I've made a
> shortcut. Since at the monitor level these two are set in two
> separate calls and minimum has to be always smaller than maximum
> (or equal to it), it may happen that one of the values we want to
> set violates this restriction. So I've put a little note in the
> public API description warning users about this.
> 
> However, the proper solution is to have a logic that checks the
> current values and based on that set either minimum or maximum
> value first. But until we get there, remove that note from the
> public API before it gets released.
> 
> Related: https://gitlab.com/libvirt/libvirt/-/issues/339
> Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
> ---
>  include/libvirt/libvirt-domain.h | 8 ++------
>  1 file changed, 2 insertions(+), 6 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|