[tor-bugs] #32708 [Core Tor/Tor]: manpage: alphabetize General Options

[Tor Bug Tracker & Wiki]

#32708: manpage: alphabetize General Options
-------------------------------------------------+-------------------------
 Reporter:  catalyst                             |          Owner:
                                                 |  catalyst
     Type:  task                                 |         Status:
                                                 |  needs_revision
 Priority:  Medium                               |      Milestone:  Tor:
                                                 |  0.4.3.x-final
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  documentation tor-client manpage     |  Actual Points:
  easy gsod                                      |
Parent ID:  #4310                                |         Points:  1
 Reviewer:  teor                                 |        Sponsor:
-------------------------------------------------+-------------------------

Comment (by catalyst):

 Replying to [comment:5 teor]:
 > All these changes look good, but the options are not actually in
 alphabetical order. (There are some cases where word breaks make ordering
 ambiguous, and others where the options are just out of order.)
 >
 > {{{
 > $ head -930 doc/tor.1.txt | tail -701 | grep '\[\[' | cut -d [ -f 3 |
 cut -d ] -f 1 > general_options.txt
 > $ sort general_options.txt > general_options_sorted.txt
 > $ diff -u general_options.txt general_options_sorted.txt
 > ...
 > }}}

 Thanks for the review and checking script! There are far fewer out-of-
 order option names if I do a case-insensitive sort.

 {{{
  Schedulers
 -KISTSchedRunInterval
 -KISTSockBufSizeFactor
 }}}
 swati mentioned to me that this ordering is intentional because it's more
 logical to put the KIST options together with the Schedulers option.

 {{{
 -Socks5ProxyUsername
  Socks5ProxyPassword
 +Socks5ProxyUsername
 }}}
 It seems odd to put Password in front of Username, so maybe this can also
 deviate from strict alphabetical order?

 {{{
  Log
  Log2
  Log3
  Log4
 +LogMessageDomains
 }}}

 This one looks reasonable to move.

 I'll make a revision to move `LogMessageDomains`, and put comments near
 the other out-of-order options explaining why they're intentionally not in
 order.

 > I suggest that we add a test to make sure the options in the general
 section are actually in order.
 I think you filed #32621 for this.

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