Point reader to a section in tor-spec.txt

diff --git a/changes/doc25237 b/changes/doc25237
new file mode 100644 (file)
index 0000000..c54307a
--- /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 750c79fd4ce725af14337c875bcd3aa5487911d0..e106ec66fa50103cc26972a7c34f4d4a9b150d09 100644 (file)
--- 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