summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2018-06-02 11:35:06 -0700
committerNick Mathewson <nickm@torproject.org>2018-06-02 11:35:06 -0700
commit3716ddf1b42270b5db76f8b7b458c5f61aa40e23 (patch)
treec2659e118c61c4e885a937d7df5b98a06aefa0d2
parent9f884a38e37ffa62eaaf73699e364b1e37935ea2 (diff)
parentf8d549db7ba1d0f0f8984f5959e669e2db539d58 (diff)
downloadtor-3716ddf1b42270b5db76f8b7b458c5f61aa40e23.tar.gz
tor-3716ddf1b42270b5db76f8b7b458c5f61aa40e23.zip
Merge remote-tracking branch 'rl1987/doc25237'
-rw-r--r--changes/doc252374
-rw-r--r--src/or/or.h4
2 files changed, 6 insertions, 2 deletions
diff --git a/changes/doc25237 b/changes/doc25237
new file mode 100644
index 0000000000..c54307a83e
--- /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 750c79fd4c..e106ec66fa 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