Move a TODO comment into doxygen comments.

1 files changed, 6 insertions, 9 deletions

diff --git a/src/or/entrynodes.c b/src/or/entrynodes.c
index bcf4182640..ad9242e45f 100644
--- a/src/or/entrynodes.c
+++ b/src/or/entrynodes.c
@@ -630,8 +630,9 @@ choose_guard_selection(const or_options_t *options,
  * Check whether we should switch from our current guard selection to a
  * different one.  If so, switch and return 1.  Return 0 otherwise.
  *
- * On a 1 return, the caller should mark all currently live circuits
- * unusable for new streams.
+ * On a 1 return, the caller should mark all currently live circuits unusable
+ * for new streams, by calling circuit_mark_all_unused_circs() and
+ * circuit_mark_all_dirty_circs_as_unusable().
  */
 int
 update_guard_selection_choice(const or_options_t *options)
@@ -665,12 +666,6 @@ update_guard_selection_choice(const or_options_t *options)
   tor_assert(new_guard_context != curr_guard_context);
   curr_guard_context = new_guard_context;
 
-  /*
-    Be sure to call:
-    circuit_mark_all_unused_circs();
-    circuit_mark_all_dirty_circs_as_unusable();
-  */
-
   return 1;
 }
 
@@ -4879,7 +4874,9 @@ entries_retry_all(const or_options_t *options)
 
 /** Helper: Update the status of all entry guards, in whatever algorithm
  * is used. Return true if we should stop using all previously generated
- * circuits. */
+ * circuits, by calling circuit_mark_all_unused_circs() and
+ * circuit_mark_all_dirty_circs_as_unusable().
+ */
 int
 guards_update_all(void)
 {