Document that the cpu_hint is only used on Windows with IOCP for now

diff --git a/include/event2/event.h b/include/event2/event.h
index 911560db0631aa3f5ea27bc24a24a63d4812e350..4b05b32538cfb589a1d60b3a9c4f9eb25c263b04 100644 (file)
--- a/include/event2/event.h
+++ b/include/event2/event.h
@@ -244,7 +244,8 @@ int event_config_set_flag(struct event_config *cfg, int flag);
 
 /**
  * Records a hint for the number of CPUs in the system. This is used for
- * tuning thread pools, etc, for optimal performance.
+ * tuning thread pools, etc, for optimal performance.  In Libevent 2.0,
+ * it is only on Windows, and only when IOCP is in use.
  *
  * @param cfg the event configuration object
  * @param cpus the number of cpus