[tor-bugs] #2325 [Tor Relay]: Document torrc format

[Tor Bug Tracker & Wiki]

#2325: Document torrc format
------------------------+---------------------------------------------------
  Reporter:  rransom    |              Owner:                  
      Type:  task       |             Status:  new             
  Priority:  normal     |          Milestone:  Tor: unspecified
 Component:  Tor Relay  |            Version:                  
  Keywords:             |             Parent:                  
    Points:             |   Actualpointsdone:                  
Pointsdone:             |       Actualpoints:                  
------------------------+---------------------------------------------------

Comment(by atagar):

 >> Arm definitely parses them.
 >
 > If so, I might call that a bug in arm. Or at least, a feature that's
 going to repeatedly bite it and its users.

 Heh, oh ye of little faith ;)

 Arm fetches the torrc file and parses it to give warnings about
 configuration issues including:

 - When single value config options are defined multiple times, overwriting
 the previous values. There was an or-talk thread (subject "gratuitous
 change blocks upgrade to 0.2.2.15-alpha :-(") where users were amazed that
 this was happening with ExcludeNodes. Arm, however, had already notified
 its users with that issue about the problem for over a year.

 - Giving a notice if the torrc differs from tor's actual state (for
 instance, the user edited the torrc and forgot to sighup).

 - Notice if the torrc can be simplified because options match their
 default values.

 Parsing also provides syntax highlighting and comment stripping which are
 nice for large torrc. Cheers! -Damian

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