[tor-commits] [tor/master] Comments: prefer circuit_build_times_disabled() to LearnCircuitBuildTimeout

[nickm at torproject.org]

commit f686fa2ee600f6670bab7531d404eaf5f8ea91ff
Author: teor <teor2345 at gmail.com>
Date:   Tue Sep 13 11:55:23 2016 +1000

    Comments: prefer circuit_build_times_disabled() to LearnCircuitBuildTimeout
---
 src/or/or.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/or/or.h b/src/or/or.h
index 7104a5c..07f94b7 100644
--- a/src/or/or.h
+++ b/src/or/or.h
@@ -3777,7 +3777,8 @@ typedef struct {
                      * unattached before we fail it? */
   int LearnCircuitBuildTimeout; /**< If non-zero, we attempt to learn a value
                                  * for CircuitBuildTimeout based on timeout
-                                 * history */
+                                 * history. Use circuit_build_times_disabled()
+                                 * rather than checking this value directly. */
   int CircuitBuildTimeout; /**< Cull non-open circuits that were born at
                             * least this many seconds ago. Used until
                             * adaptive algorithm learns a new value. */