[tor-commits] [tor/master] Clarify doc on tell_event_loop_to_run_external_code()

[nickm at torproject.org]

commit 0a10335d2e23e43de401cf955c8f188ce19106a6
Author: Nick Mathewson <nickm at torproject.org>
Date:   Fri Oct 27 11:14:37 2017 -0400

    Clarify doc on tell_event_loop_to_run_external_code()
---
 src/or/main.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/or/main.c b/src/or/main.c
index 5510df253..a615a6be0 100644
--- a/src/or/main.c
+++ b/src/or/main.c
@@ -648,7 +648,8 @@ connection_should_read_from_linked_conn(connection_t *conn)
 
 /** If we called event_base_loop() and told it to never stop until it
  * runs out of events, now we've changed our mind: tell it we want it to
- * finish. */
+ * exit once the current round of callbacks is done, so that we can
+ * run external code, and then return to the main loop. */
 void
 tell_event_loop_to_run_external_code(void)
 {