[tor-commits] [tor/master] connection: Improve function comments

[dgoulet@xxxxxxxxxxxxxx]

commit d873674fb37342285e712da054398fab23cb0091
Author: teor <teor@xxxxxxxxxxxxxx>
Date:   Wed Jan 29 18:22:21 2020 +1000

    connection: Improve function comments
    
    Improve the function comments on connection_finished_connecting(),
    to describe what the function actually does.
    
    Part of 33091.
---
 src/core/mainloop/connection.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/core/mainloop/connection.c b/src/core/mainloop/connection.c
index 223428a8f..4a2dc21f1 100644
--- a/src/core/mainloop/connection.c
+++ b/src/core/mainloop/connection.c
@@ -4970,10 +4970,10 @@ connection_finished_flushing(connection_t *conn)
   }
 }
 
-/** Called when our attempt to connect() to another server has just
- * succeeded.
+/** Called when our attempt to connect() to a server has just succeeded.
  *
- * This function just passes conn to the connection-specific
+ * This function checks if the interface address has changed (clients only),
+ * and then passes conn to the connection-specific
  * connection_*_finished_connecting() function.
  */
 static int



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