[tor-commits] [torspec/master] Document new consensus params for bug24769.

[nickm at torproject.org]

commit b9700afd49968b31367041624d5fdfb83b4ed7ee
Author: Mike Perry <mikeperry-git at torproject.org>
Date:   Wed Jan 31 17:19:48 2018 +0000

    Document new consensus params for bug24769.
---
 dir-spec.txt  |  7 ++++---
 path-spec.txt | 13 +++++++++++++
 2 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/dir-spec.txt b/dir-spec.txt
index ece2991..39355d7 100644
--- a/dir-spec.txt
+++ b/dir-spec.txt
@@ -1871,9 +1871,10 @@
 
         "cbtdisabled", "cbtnummodes", "cbtrecentcount", "cbtmaxtimeouts",
         "cbtmincircs", "cbtquantile", "cbtclosequantile", "cbttestfreq",
-        "cbtmintimeout", and "cbtinitialtimeout" -- see "2.4.5. Consensus
-        parameters governing behavior" in path-spec.txt for a series of
-        circuit build time related consensus params.
+        "cbtmintimeout", "cbtlearntimeout", "cbtmaxopencircs", and
+        "cbtinitialtimeout" -- see "2.4.5. Consensus parameters governing
+        behavior" in path-spec.txt for a series of circuit build time related
+        consensus params.
 
         "UseOptimisticData" -- If set to zero, clients by default
         shouldn't try to send optimistic data to servers until they have
diff --git a/path-spec.txt b/path-spec.txt
index 6e88cb3..1e1dfbc 100644
--- a/path-spec.txt
+++ b/path-spec.txt
@@ -546,6 +546,19 @@ of their choices.
         Effect: This is the timeout value to use before computing a timeout,
                 in milliseconds.
 
+      cbtlearntimeout
+        Default: 360
+        Min: 10
+        Max: 60000
+        Effect: This is how long idle circuits will be kept open while cbt is
+                learning a new timeout value.
+
+      cbtmaxopencircs
+        Default: 10
+        Min: 0
+        Max: 14
+        Effect: This is the maximum number of circuits that can be open at
+                at the same time during the circuit build time learning phase.
 
 2.5. Handling failure