[tor-bugs] #25237 [Core Tor/Tor]: spec: Document our circuit close reasons

[Tor Bug Tracker & Wiki]

#25237: spec: Document our circuit close reasons
------------------------------+--------------------------------
     Reporter:  dgoulet       |      Owner:  (none)
         Type:  defect        |     Status:  new
     Priority:  Medium        |  Milestone:  Tor: 0.3.4.x-final
    Component:  Core Tor/Tor  |    Version:
     Severity:  Normal        |   Keywords:  tor-spec
Actual Points:                |  Parent ID:
       Points:                |   Reviewer:
      Sponsor:                |
------------------------------+--------------------------------
 In `or.h`, we define the reason to close a circuit:

 {{{
 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt
 for
  * documentation of these. */
 #define END_CIRC_REASON_MIN_            0
 #define END_CIRC_REASON_NONE            0
 #define END_CIRC_REASON_TORPROTOCOL     1
 #define END_CIRC_REASON_INTERNAL        2
 #define END_CIRC_REASON_REQUESTED       3
 ...
 }}}

 Even though it says "See tor-spec.txt", those values aren't defined at all
 in tor-spec.txt, only the stream reasons are.

 This is a bit annoying because these values don't have any documentation
 on why and when they should be used.

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