[tor-bugs] #33778 [Core Tor/Tor]: TestingTorNetwork options in the man page are out of date

[Tor Bug Tracker & Wiki]

#33778: TestingTorNetwork options in the man page are out of date
--------------------------+------------------------------------
 Reporter:  opara         |          Owner:  (none)
     Type:  defect        |         Status:  needs_review
 Priority:  Medium        |      Milestone:  Tor: 0.4.4.x-final
Component:  Core Tor/Tor  |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:  doc           |  Actual Points:
Parent ID:                |         Points:
 Reviewer:                |        Sponsor:
--------------------------+------------------------------------
Changes (by teor):

 * keywords:   => doc
 * status:  new => needs_review
 * milestone:   => Tor: 0.4.4.x-final


Comment:

 > 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.

 I think that's the reason, but it hasn't been done consistently.

 Maybe it's worth putting the minimum and maximum values in the man page?
 Maybe it's not, they would just get out of date :-)

 Maybe it's worth consistently documenting all the INTERVAL options in the
 man page?

 In any case, those tasks can be done in other tickets.

 I'll let the reviewer decide what they want to do with the current set of
 changes.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/33778#comment:2>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online