]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
circwindow consensus param != CircWindow
authorRoger Dingledine <arma@torproject.org>
Wed, 15 Sep 2010 21:55:30 +0000 (17:55 -0400)
committerRoger Dingledine <arma@torproject.org>
Wed, 15 Sep 2010 21:55:30 +0000 (17:55 -0400)
aka update dir-spec.txt to reflect reality

doc/spec/dir-spec.txt

index bd3b8ba24585f08cad706fcbeb9d5b848a806b27..b383cdf403ee9648f799a41e44571f5c77969de1 100644 (file)
         Parameters ::= Parameter | Parameters SP Parameter
 
         The parameters list, if present, contains a space-separated list of
-        key-value pairs, sorted in lexical order by their keyword.  Each
-        parameter has its own meaning.
+        case-sensitive key-value pairs, sorted in lexical order by
+        their keyword. Each parameter has its own meaning.
 
         (Only included when the vote is generated with consensus-method 7 or
         later.)
 
         Commonly used "param" arguments at this point include:
 
-        "CircWindow" -- the default package window that circuits should
+        "circwindow" -- the default package window that circuits should
         be established with. It started out at 1000 cells, but some
         research indicates that a lower value would mean fewer cells in
         transit in the network at any given time. Obeyed by Tor 0.2.1.20
         and 0.2.2.10-alpha recognized a "CircPriorityHalflifeMsec" parameter,
         but mishandled it badly.)
 
+        See also "2.4.5. Consensus parameters governing behavior"
+        in path-spec.txt for a series of circuit build time related
+        consensus params.
+
    The authority section of a vote contains the following items, followed
    in turn by the authority's current key certificate: