[tor-commits] [tor/master] Comment-only changes to connection_connect

[nickm at torproject.org]

commit b7525c39bff1f43b1437960d7030693942e33274
Author: teor (Tim Wilson-Brown) <teor2345 at gmail.com>
Date:   Mon Dec 7 15:59:34 2015 +1100

    Comment-only changes to connection_connect
    
    port is in host order (addr is tor_addr_t, endianness is abstracted).
    
    addr and port can be different to conn->addr and conn->port if
    connecting via a proxy.
---
 src/or/connection.c |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/or/connection.c b/src/or/connection.c
index b31b99c..5ac0cb6 100644
--- a/src/or/connection.c
+++ b/src/or/connection.c
@@ -1708,10 +1708,13 @@ connection_connect_sockaddr(connection_t *conn,
 }
 
 /** Take conn, make a nonblocking socket; try to connect to
- * addr:port (they arrive in *host order*). If fail, return -1 and if
+ * addr:port (port arrives in *host order*). If fail, return -1 and if
  * applicable put your best guess about errno into *<b>socket_error</b>.
  * Else assign s to conn-\>s: if connected return 1, if EAGAIN return 0.
  *
+ * addr:port can be different to conn->addr:conn->port if connecting through
+ * a proxy.
+ *
  * address is used to make the logs useful.
  *
  * On success, add conn to the list of polled connections.