[tor-commits] [tor/master] Point reader to a section in tor-spec.txt

[nickm@xxxxxxxxxxxxxx]

commit f8d549db7ba1d0f0f8984f5959e669e2db539d58
Author: rl1987 <rl1987@xxxxxxxxxxxxxxxx>
Date:   Sat Jun 2 11:15:10 2018 +0300

    Point reader to a section in tor-spec.txt
---
 changes/doc25237 | 4 ++++
 src/or/or.h      | 4 ++--
 2 files changed, 6 insertions(+), 2 deletions(-)

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



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits