summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrl1987 <rl1987@sdf.lonestar.org>2018-06-02 11:15:10 +0300
committerrl1987 <rl1987@sdf.lonestar.org>2018-06-02 11:15:10 +0300
commitf8d549db7ba1d0f0f8984f5959e669e2db539d58 (patch)
treede4f44a82050d888157c284f98242532c9e4e065
parentd7bbfd0f6217181fc7f4a4a71d23874873a5262a (diff)
downloadtor-f8d549db7ba1d0f0f8984f5959e669e2db539d58.tar.gz
tor-f8d549db7ba1d0f0f8984f5959e669e2db539d58.zip
Point reader to a section in tor-spec.txt
-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