[tor-bugs] #33778 [Core Tor/Tor]: TestingTorNetwork options in the man page are out of date
Tor Bug Tracker & Wiki
blackhole at torproject.org
Wed Apr 1 03:44:32 UTC 2020
#33778: TestingTorNetwork options in the man page are out of date
--------------------+------------------------------
Reporter: opara | Owner: (none)
Type: defect | Status: new
Priority: Medium | Component: Core Tor/Tor
Version: | Severity: Normal
Keywords: | Actual Points:
Parent ID: | Points:
Reviewer: | Sponsor:
--------------------+------------------------------
A few of the values under {{{TestingTorNetwork}}} in {{{doc/tor.1.txt}}}
are out of date compared to the options in
{{{src/app/config/testnet.inc}}}. Also, some of the units listed for
options only state 'minutes|hours' when they actually support 'seconds' as
well. I only fixed the ones that were relevant to {{{TestingTorNetwork}}},
but there are probably others as well. Will add a PR shortly.
In addition, many of the options that are of type {{{INTERVAL}}} use
different units in the man page. For example:
{{{
ShutdownWaitLength NUM
V3AuthVotingInterval N minutes|hours
TestingV3AuthVotingStartOffset N seconds|minutes|hours
DormantClientTimeout N minutes|hours|days|weeks
}}}
Since these are all of type {{{INTERVAL}}}, is there a reason why these
units are different when all of them support any unit in {{{unitparse.c}}}
(seconds, minutes, hours, days, weeks)? One reason could be that some
options have lower bounds (for example {{{V3AuthVotingInterval}}} must be
greater than 300 seconds which is of the order of minutes), but the user
can just specify 300 seconds rather than 5 minutes.
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/33778>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
More information about the tor-bugs
mailing list