[tor-bugs] #14683 [Tor]: Document medium-scale design of key Tor abstractions

[Tor Bug Tracker & Wiki]

#14683: Document medium-scale design of key Tor abstractions
---------------------+------------------------------
 Reporter:  nickm    |          Owner:
     Type:  defect   |         Status:  new
 Priority:  normal   |      Milestone:  Tor: 0.2.???
Component:  Tor      |        Version:
 Keywords:  tor-doc  |  Actual Points:
Parent ID:           |         Points:
---------------------+------------------------------
 In between the specs and the doxygen documentation, there isn't much to
 explain _why_ our subsystems work that way, how they fit together, and so
 on.

 Some areas we should really elaborate are:
   * circuits
   * cmux
   * circuitpathbias
   * entrynodes
   * channels
   * the main event loop/connection abstraction

 We should probably try to make it a practice to ''always'' document new
 things, and to fill in documentation for older things as we can.  Whatever
 has changed most recently is probably going to be freshest on our minds,
 so let's start there.

 I'm putting this in 0.2.??? as non-blocker, but we should try to get more
 stuff documented whenever the opportunity exists.

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