[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_review
 Priority:  Medium                               |      Milestone:
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  documentation, tor-client, manpage,  |  Actual Points:
  gsod                                           |
Parent ID:  #4310                                |         Points:
 Reviewer:                                       |        Sponsor:
-------------------------------------------------+-------------------------

Comment (by catalyst):

 Thanks for the pull request!

 Running
 {{{
 sed -ne '/^== CLIEN/,/^==/p'|sed -ne 's/^\[\[\([^ ]*\)\]\].*/\1/p'
 }}}
 to extract the entry anchors, and comparing sorted and unsorted versions,
 I see:

 {{{
 --- /tmp/unsort.txt     2020-01-03 14:04:32.000000000 -0600
 +++ /tmp/sorted.txt     2020-01-03 14:04:47.000000000 -0600
 @@ -2,10 +2,9 @@
  AutomapHostsOnResolve
  AutomapHostsSuffixes
  Bridge
 -CircuitsAvailableTimeout
 -LearnCircuitBuildTimeout
  CircuitBuildTimeout
  CircuitPadding
 +CircuitsAvailableTimeout
  CircuitStreamTimeout
  ClientAutoIPv6ORPort
  ClientBootstrapConsensusAuthorityDownloadInitialDelay
 @@ -29,16 +28,19 @@
  DownloadExtraInfo
  EnforceDistinctSubnets
  EntryNodes
 -ExcludeNodes
  ExcludeExitNodes
 +ExcludeNodes
  ExitNodes
  FascistFirewall
  FirewallPorts
  GeoIPExcludeUnknown
 +GuardfractionFile
 +GuardLifetime
  HidServAuth
  HSLayer2Nodes
  HSLayer3Nodes
  HTTPTunnelPort
 +LearnCircuitBuildTimeout
  LongLivedPorts
  MapAddress
  MaxCircuitDirtiness
 @@ -47,17 +49,21 @@
  NATDPort
  NewCircuitPeriod
  NodeFamily
 +NumDirectoryGuards
 +NumEntryGuards
 +NumPrimaryGuards
  OptimisticData
 +OtherSocksPortFlags
  PathBiasCircThreshold
  PathBiasDropGuards
  PathBiasExtremeRate
 +PathBiasExtremeUseRate
  PathBiasNoticeRate
 -PathBiasWarnRate
 -PathBiasScaleThreshold
 -PathBiasUseThreshold
  PathBiasNoticeUseRate
 -PathBiasExtremeUseRate
 +PathBiasScaleThreshold
  PathBiasScaleUseThreshold
 +PathBiasUseThreshold
 +PathBiasWarnRate
  PathsNeededToBuildCircuits
  ReachableAddresses
  ReachableDirAddresses
 @@ -68,7 +74,6 @@
  SafeSocks
  SocksPolicy
  SocksPort
 -OtherSocksPortFlags
  SocksPortFlagsMisc
  SocksTimeout
  StrictNodes
 @@ -81,12 +86,7 @@
  UpdateBridgesFromAuthority
  UseBridges
  UseEntryGuards
 -GuardfractionFile
  UseGuardFraction
 -GuardLifetime
 -NumDirectoryGuards
 -NumEntryGuards
 -NumPrimaryGuards
  UseMicrodescriptors
  VirtualAddrNetworkIPv4
  VirtualAddrNetworkIPv6
 }}}

 I'm checking to see whether each out-of-order entry is commented with a
 suitable explanation. Anyone else like to help out with that?

 It looks like this line was accidentally removed from CircuitBuildTimeout?
 {{{
 -    (Default: 60 seconds)
 }}}

 There are also a few possible line movements that `git diff --color-moved`
 isn't unambiguously marking as "moved", so I'll want to do some extra
 checking of those.

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