[tor-commits] [tor/master] Update documentation comment for rend_client_reextend_intro_circuit

[nickm at torproject.org]

commit 9648f034c07603a7430b08386172e7a9c0759847
Author: Robert Ransom <rransom.8774 at gmail.com>
Date:   Mon Oct 10 05:33:53 2011 -0700

    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.
---
 src/or/rendclient.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/or/rendclient.c b/src/or/rendclient.c
index 9c247f5..f84475a 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. */