[or-cvs] [tor/master] start to document commonly used "param" arguments

[arma at seul.org]

Author: Roger Dingledine <arma at torproject.org>
Date: Sat, 19 Dec 2009 05:11:50 -0500
Subject: start to document commonly used "param" arguments
Commit: d035b65cd7a98be3dad055ac0bf885bffed896b8

---
 doc/spec/dir-spec.txt |   13 ++++++++++++-
 1 files changed, 12 insertions(+), 1 deletions(-)

diff --git a/doc/spec/dir-spec.txt b/doc/spec/dir-spec.txt
index 0bfc758..0789c12 100644
--- a/doc/spec/dir-spec.txt
+++ b/doc/spec/dir-spec.txt
@@ -1140,6 +1140,18 @@
         (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
+        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 later.
+
+        "CircPriorityHalflifeMsec" -- the halflife parameter used when
+        weighting which circuit will send the next cell. Obeyed by Tor
+        0.2.2.7-alpha and later.
+
    The authority section of a vote contains the following items, followed
    in turn by the authority's current key certificate:
 
@@ -2145,7 +2157,6 @@
 
 A. Consensus-negotiation timeline.
 
-
    Period begins: this is the Published time.
      Everybody sends votes
    Reconciliation: everybody tries to fetch missing votes.
-- 
1.5.6.5