Write a comment to explain may_need_rebind condition

diff --git a/src/core/mainloop/connection.c b/src/core/mainloop/connection.c
index 5ebfac6bee48da41da57bdf58f1df9f8f5da6f14..5c0799fbe3d393dc525a9f70370e13e6b1f33994 100644 (file)
--- a/src/core/mainloop/connection.c
+++ b/src/core/mainloop/connection.c
@@ -2797,6 +2797,15 @@ retry_listener_ports(smartlist_t *old_conns,
           break;
         }
 #ifdef ENABLE_LISTENER_REBIND
+        /* Rebinding may be needed if all of the following are true:
+         * 1) Address family is the same in old and new listeners.
+         * 2) Port number matches exactly (numeric value is the same).
+         * 3) *One* of listeners (either old one or new one) has a
+         *    wildcard IP address (0.0.0.0 or [::]).
+         *
+         * These are the exact conditions for a first bind() syscall
+         * to fail with EADDRINUSE.
+         */
         const int may_need_rebind =
           tor_addr_family(&wanted->addr) == tor_addr_family(&conn->addr) &&
           port_matches_exact && bool_neq(tor_addr_is_null(&wanted->addr),