[tor-bugs] #33188 [Core Tor/Tor]: Tor Manual: Alphabetize Server and Directory Server Options

[Tor Bug Tracker & Wiki]

#33188: Tor Manual: Alphabetize Server and Directory Server Options
-------------------------------------------------+-------------------------
 Reporter:  swati                                |          Owner:  (none)
     Type:  task                                 |         Status:
                                                 |  needs_revision
 Priority:  Medium                               |      Milestone:
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  documentation tor-client manpage     |  Actual Points:
  easy 043-can                                   |
Parent ID:  #4310                                |         Points:
 Reviewer:  catalyst                             |        Sponsor:
-------------------------------------------------+-------------------------

Comment (by teor):

 Replying to [comment:6 nickm]:
 > Replying to [comment:4 catalyst]:
 > > Replying to [comment:1 swati]:
 > >
 > > > Created a Pull Request - https://github.com/torproject/tor/pull/1715
 for the following changes:
 > > >  - Created a new section titled **Statistics Options**. Pulled out
 all the stats-related and extra-info related options, and put them into
 this new section.
 > >
 > > Looks good!  I would suggest a few minor changes to the introductory
 text.  Change "following options describe" to "following options affect".
 Change "that Tor collects and writes" to "that Tor relays collect and
 publish".  What do you think?
 > >
 > > > Should I pull out the DownloadExtraInfo option (that is presently
 under the Client Options section) and move it under **Statistics
 Options**?
 > >
 > > I think this still belongs in the Client Options section, because it
 doesn't affect how relays report their statistics.

 I agree, the DownloadExtraInfo option works on clients and relays, so it
 should not be in a relay-only section.

 > > Also, I think RephistTrackTime might belong in the stats section,
 because it changes the length of the period that relays use to report
 their bandwidth stats.  (I'm still researching this.  Anyone else have
 ideas?)
 >
 > Everything with "Rephist" in the name should go under statistics.

 RephistTrackTime is used to clean router reputation history. This history
 is used by clients, relays, and authorities (in different ways). See:
 https://gitweb.torproject.org/tor.git/tree/src/core/mainloop/mainloop.c#n1412
 https://gitweb.torproject.org/tor.git/tree/src/core/mainloop/mainloop.c#n2008

 Authorities use it in their votes, clients and relays use it to check
 whether another relay might be up.

 So I think RephistTrackTime belongs in some sort of "common options"
 section. (Or in client options, if there isn't a common options section.)

 The bandwidth stats interval is a fixed constant, as are all stats
 intervals. We don't let people configure them, it would make metrics code
 much more complex :-)

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