[tor-commits] [tor/master] Updated the TestingTorNetwork man page options

[asn at torproject.org]

commit cc5319bf8e324f8beea01cf562de4b78f42a2917
Author: Steven Engler <sengler at uwaterloo.ca>
Date:   Tue Mar 31 20:24:41 2020 -0400

    Updated the TestingTorNetwork man page options
    
    Updated 'doc/tor.1.txt' to match 'src/app/config/testnet.inc'.
---
 changes/ticket33778        |  3 +++
 doc/tor.1.txt              | 19 +++++++++----------
 src/app/config/testnet.inc |  2 ++
 3 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/changes/ticket33778 b/changes/ticket33778
new file mode 100644
index 000000000..a33c647a6
--- /dev/null
+++ b/changes/ticket33778
@@ -0,0 +1,3 @@
+  o Documentation (manpage):
+    - Updated the options set by TestingTorNetwork in the man page.
+      Closes ticket 33778.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index ba9b9bb5e..e87385f85 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -3045,7 +3045,7 @@ on the public Tor network.
     multiple times: the values from multiple lines are spliced together. When
     this is set then **VersioningAuthoritativeDirectory** should be set too.
 
-[[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **minutes**|**hours**::
+[[V3AuthDistDelay]] **V3AuthDistDelay** __N__ **seconds**|**minutes**|**hours**::
     V3 authoritative directories only. Configures the server's preferred  delay
     between publishing its consensus and signature and assuming  it has all the
     signatures from all the other authorities. Note that the actual time used
@@ -3066,7 +3066,7 @@ on the public Tor network.
     different identity.  This feature is used to migrate directory authority
     keys in the event of a compromise.  (Default: 0)
 
-[[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **minutes**|**hours**::
+[[V3AuthVoteDelay]] **V3AuthVoteDelay** __N__ **seconds**|**minutes**|**hours**::
     V3 authoritative directories only. Configures the server's preferred delay
     between publishing its vote and assuming it has all the votes from all the
     other authorities. Note that the actual time used is not the server's
@@ -3341,12 +3341,10 @@ The following options are used for running a testing Tor network.
     running.
     (Default: 0) +
 
-       ServerDNSAllowBrokenConfig 1
        DirAllowPrivateAddresses 1
        EnforceDistinctSubnets 0
        AssumeReachable 1
        AuthDirMaxServersPerAddr 0
-       AuthDirMaxServersPerAuthAddr 0
        ClientBootstrapConsensusAuthorityDownloadInitialDelay 0
        ClientBootstrapConsensusFallbackDownloadInitialDelay 0
        ClientBootstrapConsensusAuthorityOnlyDownloadInitialDelay 0
@@ -3358,11 +3356,11 @@ The following options are used for running a testing Tor network.
        V3AuthVotingInterval 5 minutes
        V3AuthVoteDelay 20 seconds
        V3AuthDistDelay 20 seconds
-       MinUptimeHidServDirectoryV2 0 seconds
-       TestingV3AuthInitialVotingInterval 5 minutes
+       TestingV3AuthInitialVotingInterval 150 seconds
        TestingV3AuthInitialVoteDelay 20 seconds
        TestingV3AuthInitialDistDelay 20 seconds
        TestingAuthDirTimeToLearnReachability 0 minutes
+       MinUptimeHidServDirectoryV2 0 minutes
        TestingServerDownloadInitialDelay 0
        TestingClientDownloadInitialDelay 0
        TestingServerConsensusDownloadInitialDelay 0
@@ -3373,8 +3371,9 @@ The following options are used for running a testing Tor network.
        TestingDirConnectionMaxStall 30 seconds
        TestingEnableConnBwEvent 1
        TestingEnableCellStatsEvent 1
+       RendPostPeriod 2 minutes
 
-[[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **minutes**|**hours**::
+[[TestingAuthDirTimeToLearnReachability]] **TestingAuthDirTimeToLearnReachability** __N__ **seconds**|**minutes**|**hours**::
     After starting as an authority, do not make claims about whether routers
     are Running until this much time has passed. Changing this requires
     that **TestingTorNetwork** is set.  (Default: 30 minutes)
@@ -3504,17 +3503,17 @@ The following options are used for running a testing Tor network.
     we replace it and issue a new key?
     (Default: 3 hours for link and auth; 1 day for signing.)
 
-[[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **minutes**|**hours**::
+[[TestingV3AuthInitialDistDelay]] **TestingV3AuthInitialDistDelay** __N__ **seconds**|**minutes**|**hours**::
     Like V3AuthDistDelay, but for initial voting interval before
     the first consensus has been created. Changing this requires that
     **TestingTorNetwork** is set. (Default: 5 minutes)
 
-[[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **minutes**|**hours**::
+[[TestingV3AuthInitialVoteDelay]] **TestingV3AuthInitialVoteDelay** __N__ **seconds**|**minutes**|**hours**::
     Like V3AuthVoteDelay, but for initial voting interval before
     the first consensus has been created. Changing this requires that
     **TestingTorNetwork** is set. (Default: 5 minutes)
 
-[[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **minutes**|**hours**::
+[[TestingV3AuthInitialVotingInterval]] **TestingV3AuthInitialVotingInterval** __N__ **seconds**|**minutes**|**hours**::
     Like V3AuthVotingInterval, but for initial voting interval before the first
     consensus has been created. Changing this requires that
     **TestingTorNetwork** is set. (Default: 30 minutes)
diff --git a/src/app/config/testnet.inc b/src/app/config/testnet.inc
index f146a03cd..907c35f97 100644
--- a/src/app/config/testnet.inc
+++ b/src/app/config/testnet.inc
@@ -1,3 +1,5 @@
+// When modifying, don't forget to update the defaults
+// for 'TestingTorNetwork' in 'doc/tor.1.txt'
 { "DirAllowPrivateAddresses", "1" },
 { "EnforceDistinctSubnets", "0" },
 { "AssumeReachable", "1" },