From: Nick Mathewson <nickm@torproject.org>
Date: Thu, 9 Dec 2010 17:17:11 +0000 (-0500)
Subject: Document that the cpu_hint is only used on Windows with IOCP for now
X-Git-Tag: release-2.0.10-stable~5
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=57689c4484ba3fd098739bcea1557c329a8fa16b;p=libevent

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 911560db..4b05b325 100644
--- 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