[tor-bugs] #3155 [Tor Relay]: Single Underscore in Option Name

[Tor Bug Tracker & Wiki]

#3155: Single Underscore in Option Name
----------------------------+-----------------------------------------------
    Reporter:  atagar       |       Owner:  nickm           
        Type:  enhancement  |      Status:  needs_revision  
    Priority:  trivial      |   Milestone:  Tor: unspecified
   Component:  Tor Relay    |     Version:                  
  Resolution:               |    Keywords:  easy            
      Parent:               |      Points:                  
Actualpoints:               |  
----------------------------+-----------------------------------------------
Changes (by rransom):

  * status:  needs_review => needs_revision


Comment:

 `_UsingTestNetworkDefaults` should be renamed in a separate commit on the
 same Git branch.  (This is one major reason that Git branches are usually
 preferred over patches.)

 The commit which renames `_UsingTestNetworkDefaults` to begin with `___`
 will also cause Tor to not save it when it writes a config file to disk
 (or to the control port).  This is a desirable side effect, but should be
 mentioned in the commit message.

 The commit which renames `_UsingTestNetworkDefaults` will break any Tor
 configuration containing `_UsingTestNetworkDefaults`.  This is
 undesirable; does anyone who runs a Tor test network allow a Tor
 controller to ‘`SAVECONF`’ the test Tor instances?

 “preceeded” is spelled “preceded”.

 You could fit the important part of the don't-tell-controllers-about-
 triple-underscore-options commit message on one line as: “`Hide options
 beginning with "___" from GETINFO config/items`”

 `_UseFilteringSSLBufferevents` is intended to be user-settable, and should
 not be hidden.  Perhaps a separate branch should rename it to
 `UseFilteringSSLBufferevents`.  Perhaps it should be removed now.  Either
 way, this ticket's branch shouldn't touch it; it's a separate buglet.

 The code change looks good.  Thanks!

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