[tor-commits] [tor/master] finish documentation on live_consensus_is_missing

[nickm at torproject.org]

commit d43dc120e88a61911b1bd06dc67f7da8de971a03
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Dec 18 15:00:48 2017 -0500

    finish documentation on live_consensus_is_missing
---
 src/or/entrynodes.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/or/entrynodes.c b/src/or/entrynodes.c
index fa8d62a4f..292a393e5 100644
--- a/src/or/entrynodes.c
+++ b/src/or/entrynodes.c
@@ -1094,7 +1094,11 @@ select_and_add_guard_item_for_sample(guard_selection_t *gs,
   return added_guard;
 }
 
-/** Return true iff we need a consensus to maintain our  */
+/**
+ * Return true iff we need a consensus to update our guards, but we don't
+ * have one. (We can return 0 here either if the consensus is _not_ missing,
+ * or if we don't need a consensus because we're using bridges.)
+ */
 static int
 live_consensus_is_missing(const guard_selection_t *gs)
 {