Update some documentation for the bug 1525 fix

diff --git a/changes/bug1525 b/changes/bug1525
index 64f5b175d3a8ca05fbf00b1dddbff19c21890088..04f2e3b7938fa8aabf24d9e353b847205fd606d7 100644 (file)
--- a/changes/bug1525
+++ b/changes/bug1525
@@ -1,4 +1,4 @@
   o Minor bugfixes:
     - Ensure DNS requests launched by "RESOLVE" commands from the controller
-      respect __LeaveStreamsUnattached. Bugfix on 0.2.2.14-alpha;
+      respect __LeaveStreamsUnattached. Bugfix on 0.2.0.1-alpha;
       fixes bug 1525.

diff --git a/src/or/connection_edge.c b/src/or/connection_edge.c
index 365a7972e3819adc3f1a344f914bb94e94822591..a0f6e85c5cf691a7966d82c7d1e320e985569aa0 100644 (file)
--- a/src/or/connection_edge.c
+++ b/src/or/connection_edge.c
@@ -1409,7 +1409,10 @@ consider_plaintext_ports(edge_connection_t *conn, uint16_t port)
 #define TRACKHOSTEXITS_RETRIES 5
 
 /** Call connection_ap_handshake_rewrite_and_attach() unless a controller
- *  asked us to leave streams unattached.
+ *  asked us to leave streams unattached. Return 0 in that case.
+ *
+ *  See connection_ap_handshake_rewrite_and_attach()'s
+ *  documentation for arguments and return value.
  */
 int
 connection_ap_rewrite_and_attach_if_allowed(edge_connection_t *conn,