Comments: prefer circuit_build_times_disabled() to LearnCircuitBuildTimeout

2024-12-06 19:41:15 +01:00 · 2016-09-13 11:55:23 +10:00
parent a00fee2f54
commit f686fa2ee6
1 changed files with 2 additions and 1 deletions
@@ -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. */