[tor-bugs] #21715 [User Experience/Website]: Possible error in the Tor manual (section "NumEntryGuards NUM")

[Tor Bug Tracker & Wiki]

#21715: Possible error in the Tor manual (section "NumEntryGuards NUM")
-----------------------------------------+---------------------------------
     Reporter:  moe-szyslak-0            |      Owner:  hiro
         Type:  defect                   |     Status:  new
     Priority:  Medium                   |  Milestone:
    Component:  User Experience/Website  |    Version:
     Severity:  Normal                   |   Keywords:  Tor Project: manual
Actual Points:                           |  Parent ID:
       Points:                           |   Reviewer:
      Sponsor:                           |
-----------------------------------------+---------------------------------
 In both, the Tor -stable Manual and the Tor -alpha Manual, there is a
 possible error in the section "NumEntryGuards NUM".

 Literally, this is the description of the "NumEntryGuards NUM" option: "If
 UseEntryGuards is set to 1, we will try to pick a total of NUM routers as
 long-term entries for our circuits. If NUM is 0, we try to learn the
 number from the NumEntryGuards consensus parameter, and default to 3 if
 the consensus parameter isn’t set. (Default: 0)".

 But I think the correct description would be: "If UseEntryGuards is set to
 1, we will try to pick a total of NUM routers as long-term entries for our
 circuits. If NUM is 0, we try to learn the number from the NumEntryGuards
 consensus parameter, and default to 1 if the consensus parameter isn’t
 set. (Default: 0)". Because Tor currently chooses a single entry guard,
 does not choose three.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/21715>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online