[or-cvs] r15254: Comments and doc tweaks on Karsten's testing-dir-networks pa (in tor/trunk: doc src/or)

[nickm@xxxxxxxx]

Author: nickm
Date: 2008-06-14 12:11:37 -0400 (Sat, 14 Jun 2008)
New Revision: 15254

Modified:
   tor/trunk/doc/tor.1.in
   tor/trunk/src/or/config.c
   tor/trunk/src/or/or.h
Log:
Comments and doc tweaks on Karsten's testing-dir-networks patch

Modified: tor/trunk/doc/tor.1.in
===================================================================
--- tor/trunk/doc/tor.1.in	2008-06-14 16:01:29 UTC (rev 15253)
+++ tor/trunk/doc/tor.1.in	2008-06-14 16:11:37 UTC (rev 15254)
@@ -1346,7 +1346,9 @@
 .LP
 .TP
 \fBDirTimeToLearnReachability\fR \fR\fIN\fR \fBminutes\fR|\fBhours\fP
-Consider routers as Running this time after starting an authority.
+After starting as an authority, do not make claims about whether routers are
+Running until this much time has passed.
+Changing this requires that\fBTestingTorNetwork\fR is set.
 (Default: 30 minutes)
 .LP
 .TP

Modified: tor/trunk/src/or/config.c
===================================================================
--- tor/trunk/src/or/config.c	2008-06-14 16:01:29 UTC (rev 15253)
+++ tor/trunk/src/or/config.c	2008-06-14 16:11:37 UTC (rev 15254)
@@ -3382,6 +3382,8 @@
            "a non-default set of DirServers.");
   }
 
+  /*XXXX021 checking for defaults manually like this is a bit fragile.*/
+
   /* Keep changes to hard-coded values synchronous to man page and default
    * values table. */
   if (options->V3AuthInitialVotingInterval != 30*60 &&
@@ -3891,6 +3893,12 @@
    * for a list of dependent config options, re-initialize newoptions
    * with the new defaults, and assign all options to it second time. */
   if (newoptions->TestingTorNetwork) {
+    /* XXXX021 this is a bit of a kludge.  perhaps there's a better way to do
+     * this?  We could, for example, make the parsing algorithm do two passes
+     * over the configuration.  If it finds any "suite" options like
+     * TestingTorNetwork, it could change the defaults before its second pass.
+     * Not urgent so long as this seems to work, but at any sign of trouble,
+     * let's clean it up.  -NM */
 
     /* Change defaults. */
     int i;

Modified: tor/trunk/src/or/or.h
===================================================================
--- tor/trunk/src/or/or.h	2008-06-14 16:01:29 UTC (rev 15253)
+++ tor/trunk/src/or/or.h	2008-06-14 16:11:37 UTC (rev 15254)
@@ -2355,24 +2355,30 @@
    * migration purposes? */
   int V3AuthUseLegacyKey;
 
-  /** The length of time that we think an initial consensus should be
-   * fresh. */
+  /*XXXX021 I think all these "Testing Networks only" options should perhaps
+   * have a common prefix. -NM */
+  /** The length of time that we think an initial consensus should be fresh.
+   * Only altered on testing networks. */
   int V3AuthInitialVotingInterval;
 
-  /** The length of time we think it will take to distribute initial
-   * votes. */
+  /** The length of time we think it will take to distribute initial votes.
+   * Only altered on testing networks. */
   int V3AuthInitialVoteDelay;
 
   /** The length of time we think it will take to distribute initial
-   * signatures. */
+   * signatures.  Only altered on testing networks.*/
   int V3AuthInitialDistDelay;
 
-  /** If an authority has been around for less than this amount of time,
-   * its reachability information is not accurate. */
+  /*XXXX021 why is this not prefixed to indicate that it's an authority
+   * option? */
+  /** If an authority has been around for less than this amount of time, it
+   * does not believe its reachability information is accurate.  Only
+   * altered on testing networks. */
   int DirTimeToLearnReachability;
 
   /** Clients don't download any descriptor this recent, since it will
-   * probably not have propagated to enough caches. */
+   * probably not have propagated to enough caches.  Only altered on testing
+   * networks. */
   int EstimatedDescriptorPropagationTime;
 
   /** If true, we take part in a testing network. Change the defaults of a