Opened 4 months ago

Closed 2 months ago

#21715 closed defect (fixed)

Possible error in the Tor manual (section "NumEntryGuards NUM")

Reported by: moe-szyslak-0 Owned by: dgoulet
Priority: Medium Milestone: Tor: 0.3.1.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: easy doc
Cc: Actual Points:
Parent ID: Points: 0.1
Reviewer: Sponsor:

Description

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.

Child Tickets

Change History (9)

comment:1 Changed 4 months ago by arma

  • Component changed from User Experience/Website to Core Tor/Tor

Looks like we did indeed change the default default to 1 some time ago.

comment:2 Changed 4 months ago by teor

  • Keywords easy doc added; Tor Project: manual removed
  • Milestone set to Tor: 0.3.1.x-final
  • Owner hiro deleted
  • Status changed from new to assigned

comment:3 Changed 3 months ago by dgoulet

  • Status changed from assigned to new

No owner so putting that back in new.

comment:4 Changed 3 months ago by dgoulet

  • Owner set to dgoulet
  • Status changed from new to accepted

Taking those ticket for patches.

comment:5 Changed 2 months ago by dgoulet

  • Points set to 0.1

comment:6 Changed 2 months ago by dgoulet

  • Status changed from accepted to needs_review

See branch bug21715_031_01.

comment:7 Changed 2 months ago by nickm

  • Status changed from needs_review to needs_revision

The new text seems okay, but the defaults are still "0".

comment:8 Changed 2 months ago by dgoulet

  • Status changed from needs_revision to needs_review

Arf... indeed. Fixup commit in bug21715_031_01.

comment:9 Changed 2 months ago by nickm

  • Resolution set to fixed
  • Status changed from needs_review to closed

squashed and merged

Note: See TracTickets for help on using tickets.