Browse Source

Comments: prefer circuit_build_times_disabled() to LearnCircuitBuildTimeout

teor 7 years ago
parent
commit
f686fa2ee6
1 changed files with 2 additions and 1 deletions
  1. 2 1
      src/or/or.h

+ 2 - 1
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. */