aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Ransom <rransom.8774@gmail.com>2011-10-10 05:33:53 -0700
committerRobert Ransom <rransom.8774@gmail.com>2011-10-10 05:33:53 -0700
commit9648f034c07603a7430b08386172e7a9c0759847 (patch)
tree7a4944193e838cef1324abedad52090498538d8d
parent274b25de1258647d00509b4a8e378a2115da066c (diff)
downloadtor-9648f034c07603a7430b08386172e7a9c0759847.tar
tor-9648f034c07603a7430b08386172e7a9c0759847.tar.gz
Update documentation comment for rend_client_reextend_intro_circuit
One of its callers assumes a non-zero result indicates a permanent failure (i.e. the current attempt to connect to this HS either has failed or is doomed). The other caller only requires that this function's result never equal -2. Bug reported by Sebastian Hahn.
-rw-r--r--src/or/rendclient.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/or/rendclient.c b/src/or/rendclient.c
index 9c247f5c7..f84475acb 100644
--- a/src/or/rendclient.c
+++ b/src/or/rendclient.c
@@ -80,8 +80,8 @@ rend_client_send_establish_rendezvous(origin_circuit_t *circ)
/** Extend the introduction circuit <b>circ</b> to another valid
* introduction point for the hidden service it is trying to connect
* to, or mark it and launch a new circuit if we can't extend it.
- * Return 0 on success. Return -1 and mark the introduction
- * circuit on failure.
+ * Return 0 on success or possible success. Return -1 and mark the
+ * introduction circuit for close on permanent failure.
*
* On failure, the caller is responsible for marking the associated
* rendezvous circuit for close. */