[tor-bugs] #32846 [Core Tor/Tor]: Tor Manual: Alphabetize Client Options

[Tor Bug Tracker & Wiki]

#32846: Tor Manual: Alphabetize Client Options
-------------------------------------------------+-------------------------
 Reporter:  swati                                |          Owner:  (none)
     Type:  project                              |         Status:
                                                 |  needs_revision
 Priority:  Medium                               |      Milestone:
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  documentation, tor-client, manpage,  |  Actual Points:
  gsod, extra-review                             |
Parent ID:  #4310                                |         Points:
 Reviewer:  catalyst, teor                       |        Sponsor:
-------------------------------------------------+-------------------------
Changes (by teor):

 * status:  needs_review => needs_revision


Comment:

 Looks good!

 I've tried to prioritise the changes I'm suggesting. Feel free to mark as
 merge ready when the "must" and "useful" changes are done.

 Here are the things I think we must fix before merging:
 * GuardfractionFile should be moved to the directory authority section. It
 doesn't apply to clients.

 Here are some useful things that I think would help people read the
 manual:
 * ReducedConnectionPadding logically belongs immediately after
 ConnectionPadding.
 * ReducedCircuitPadding logically belongs immediately after
 CircuitPadding.
   * CircuitPadding splits the circuit timeout option group. If we're going
 to put it out of order anyway, maybe we should put it with
 ConnectionPadding.
 * FascistFirewall* logically belongs after Reachable*Addresses.
 * Reject and Warn PlaintextPorts belong together, probably near SafeSocks.
 They all do similar things.

 Here are things we could fix now, but we could also do the fix in another
 ticket, possibly by creating a new subsection:
 * StrictNodes and GeoIPExcludeUnknown might logically belong after
 ExcludeNodes
 * All the *Nodes options (including the HS*Nodes) options, would make
 sense together
 * This is a big change, so it probably needs another ticket

 If we create a section for the *Nodes options, we could mark them as
 advanced options. They're all options that might compromise anonymity, by
 changing how tor behaves.

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