[tor-commits] [torspec/main] Clarify the behavior of some circuit timeout params.

[nickm at torproject.org]

commit 0911bbd0cdb5459dd0eb948694f98066712cd084
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Dec 8 11:10:05 2021 -0500

    Clarify the behavior of some circuit timeout params.
    
    In particular, this commit clarifies that the ranges of some
    parameters are such that choosing a very high value will, in effect,
    disable parts of the circuit timeout inference code.
---
 path-spec.txt | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/path-spec.txt b/path-spec.txt
index 4422be4..33d50e5 100644
--- a/path-spec.txt
+++ b/path-spec.txt
@@ -633,8 +633,8 @@ Tables of Contents
         Default: 20
         Min: 3
         Max: 1000
-        Effect: This is the number of circuit build times to keep track of
-                for the following option.
+        Effect: This is the number of circuit build outcomes (success vs
+                timeout) to keep track of for the following option.
 
       cbtmaxtimeouts
         Default: 18
@@ -644,6 +644,10 @@ Tables of Contents
                 circuit attempts, the client should discard all of its
                 history and begin learning a fresh timeout value.
 
+                Note that if this parameter's value is greater than the value
+                of 'cbtrecentcount', then the history will never be
+                discarded because of this feature.
+
       cbtmincircs
         Default: 100
         Min: 1
@@ -651,6 +655,12 @@ Tables of Contents
         Effect: This is the minimum number of circuits to build before
                 computing a timeout.
 
+                Note that if this parameter's value is higher than 1000 (the
+                number of time observations that a client keeps in its
+                circular buffer), circuit build timeout calculation is
+                effectively disabled, and the default timeouts are used
+                indefinitely.
+
       cbtquantile
         Default: 80
         Min: 10