From f8d549db7ba1d0f0f8984f5959e669e2db539d58 Mon Sep 17 00:00:00 2001 From: rl1987 Date: Sat, 2 Jun 2018 11:15:10 +0300 Subject: [PATCH] Point reader to a section in tor-spec.txt --- changes/doc25237 | 4 ++++ src/or/or.h | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 changes/doc25237 diff --git a/changes/doc25237 b/changes/doc25237 new file mode 100644 index 000000000..c54307a83 --- /dev/null +++ b/changes/doc25237 @@ -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. diff --git a/src/or/or.h b/src/or/or.h index 750c79fd4..e106ec66f 100644 --- a/src/or/or.h +++ b/src/or/or.h @@ -728,8 +728,8 @@ typedef enum { /** Catch-all "other" reason for closing origin circuits. */ #define END_CIRC_AT_ORIGIN -1 -/* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for - * documentation of these. */ +/* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt + * section 5.4 for documentation of these. */ #define END_CIRC_REASON_MIN_ 0 #define END_CIRC_REASON_NONE 0 #define END_CIRC_REASON_TORPROTOCOL 1