Point reader to a section in tor-spec.txt

This commit is contained in:
rl1987 2018-06-02 11:15:10 +03:00
parent d7bbfd0f62
commit f8d549db7b
2 changed files with 6 additions and 2 deletions

4
changes/doc25237 Normal file
View File

@ -0,0 +1,4 @@
o Documentation:
- In code comment, point the reader to the exact section
in Tor specification that specifies circuit close error
code values. Resolves ticket 25237.

View File

@ -728,8 +728,8 @@ typedef enum {
/** Catch-all "other" reason for closing origin circuits. */ /** Catch-all "other" reason for closing origin circuits. */
#define END_CIRC_AT_ORIGIN -1 #define END_CIRC_AT_ORIGIN -1
/* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt
* documentation of these. */ * section 5.4 for documentation of these. */
#define END_CIRC_REASON_MIN_ 0 #define END_CIRC_REASON_MIN_ 0
#define END_CIRC_REASON_NONE 0 #define END_CIRC_REASON_NONE 0
#define END_CIRC_REASON_TORPROTOCOL 1 #define END_CIRC_REASON_TORPROTOCOL 1