[tor-commits] [tor/master] Improve doc of `primary_guards_up_to_date`.

[nickm at torproject.org]

commit 13f5adc86c30101a32fedcd1713443eb4c43a397
Author: George Kadianakis <desnacked at riseup.net>
Date:   Wed Feb 7 11:46:30 2018 +0200

    Improve doc of `primary_guards_up_to_date`.
---
 src/or/entrynodes.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/or/entrynodes.h b/src/or/entrynodes.h
index b7b110eeb..d56249831 100644
--- a/src/or/entrynodes.h
+++ b/src/or/entrynodes.h
@@ -220,9 +220,10 @@ struct guard_selection_s {
   guard_selection_type_t type;
 
   /**
-   * A value of 1 means that primary_entry_guards is up-to-date; 0
-   * means we need to recalculate it before using primary_entry_guards
-   * or the is_primary flag on any guard.
+   * A value of 1 means that primary_entry_guards is up-to-date with respect to
+   * the consensus and status info that we currently have; 0 means we need to
+   * recalculate it before using primary_entry_guards or the is_primary flag on
+   * any guard.
    */
   int primary_guards_up_to_date;