[tor-bugs] #32467 [Core Tor/Tor]: Document tor's --dump-config command in the man page

[Tor Bug Tracker & Wiki]

#32467: Document tor's --dump-config command in the man page
-------------------------------------------------+-------------------------
 Reporter:  teor                                 |          Owner:  nickm
     Type:  defect                               |         Status:
                                                 |  reopened
 Priority:  Medium                               |      Milestone:  Tor:
                                                 |  0.4.3.x-final
Component:  Core Tor/Tor                         |        Version:  Tor:
                                                 |  0.3.2.1-alpha
 Severity:  Normal                               |     Resolution:
 Keywords:  network-team-roadmap-november, 042   |  Actual Points:  0
  -backport-maybe, consider-backport-            |
  immediately                                    |
Parent ID:  #29211                               |         Points:  0.1
 Reviewer:  ahf                                  |        Sponsor:
                                                 |  Sponsor31-can
-------------------------------------------------+-------------------------
Changes (by teor):

 * status:  closed => reopened
 * resolution:  implemented =>


Comment:

 Replying to [comment:1 nickm]:
 > Possible documentation in `ticket32467` with PR at
 https://github.com/torproject/tor/pull/1532.
 >
 > I kinda forgot what `non-builtin` did, so I had to look at the code.

 As far as I can tell, `non-builtin` and `short` are now synonyms.

 Because when `non-builtin` passes `config_dump(..., /* default_options */
 NULL, ...)`, `config_dump()` replaces `NULL` with a newly-allocated copy
 of the default options. Instead, it should replace them with a zeroed-out
 copy.

 Can you give a command-line where `non-builtin` and `short` differ?

 Here's what I tried:
 {{{
 tor --dump-config short
 tor --dump-config non-builtin
 tor --dump-config short SOCKSPort 0
 tor --dump-config non-builtin SOCKSPort 0
 tor --dump-config short SOCKSPort 1
 tor --dump-config non-builtin SOCKSPort 1
 }}}

 (Also string-based options like Nickname and ContactInfo.)

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