[tor-commits] [tor/master] main: Update periodic events comment based on latest code

[nickm at torproject.org]

commit 87cb9ce90088bbe3e677804eca7c1ffa4f63a1cb
Author: David Goulet <dgoulet at torproject.org>
Date:   Wed Apr 18 10:25:39 2018 -0400

    main: Update periodic events comment based on latest code
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 src/or/main.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/or/main.c b/src/or/main.c
index 565131cb3..0a796c0fa 100644
--- a/src/or/main.c
+++ b/src/or/main.c
@@ -1523,8 +1523,8 @@ teardown_periodic_events(void)
   periodic_events_initialized = 0;
 }
 
-/** Do a pass at all our periodic events, destroy those we don't need anymore
- * and enabled those we need now using the given options. */
+/** Do a pass at all our periodic events, disable those we don't need anymore
+ * and enable those we need now using the given options. */
 static void
 rescan_periodic_events(const or_options_t *options)
 {
@@ -1547,15 +1547,15 @@ rescan_periodic_events(const or_options_t *options)
   }
 }
 
-/* We just got new options globally set, see if we need to destroy or setup
+/* We just got new options globally set, see if we need to enabled or disable
  * periodic events. */
 void
 periodic_events_on_new_options(const or_options_t *options)
 {
-  /* Only if we've already initialized once the events, teardown them all and
-   * reinitialize. It is just simpler that way instead of going through all
-   * currently enabled events and trying to destroy only the one that could be
-   * affected. */
+  /* Only if we've already initialized the events, rescan the list which will
+   * enable or disable events depending on our roles. This will be called at
+   * bootup and we don't want this function to initialize the events because
+   * they aren't set up at this stage. */
   if (periodic_events_initialized) {
     rescan_periodic_events(options);
   }