[tor-bugs] #23845 [Core Tor/Tor]: Document a stable tor main function

[Tor Bug Tracker & Wiki]

#23845: Document a stable tor main function
-----------------------------------------+---------------------------------
 Reporter:  hellais                      |          Owner:  nickm
     Type:  enhancement                  |         Status:  merge_ready
 Priority:  Medium                       |      Milestone:  Tor:
                                         |  0.3.3.x-final
Component:  Core Tor/Tor                 |        Version:
 Severity:  Normal                       |     Resolution:
 Keywords:  tor-mobile, review-group-24  |  Actual Points:
Parent ID:  #23684                       |         Points:
 Reviewer:                               |        Sponsor:  Sponsor8
-----------------------------------------+---------------------------------
Changes (by ahf):

 * status:  needs_review => merge_ready


Comment:

 `72b5e4a2db4282002fe50e11c2b8a79e108d30f8` looks fine.

 In `8dd957cb8ae5c82da576e7720b1bb3b846089f98` the comment:

 {{{
  * This interface is intended for use by programs that need to link Tor as
  * a library, and launch it in a separate thread.  If you have the ability
  * to run Tor as a separate process, you probably should.
  **/
 }}}

 reads a bit to me that this API is only useful if you have Tor running in
 a thread (but not as a process) - isn't it useful in **both** cases?

 Otherwise this commit looks good as well. Nice with a documented, public,
 header! :-)

 `a7c126f65438a8dcde5663a731f0f8528e480bcc` looks good.

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