Opened 6 years ago

Last modified 2 years ago

#9655 new enhancement

Tor manual's config default options could be clearer

Reported by: Ry Owned by:
Priority: Very Low Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords: tor-relay docs defaults easy english style manpage
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Currently the default value for an option is suffixed on the description body, e.g.

UseMicrodescriptors 0|1|auto
Microdescriptors are a smaller version of the information that Tor needs in order to build its circuits. Using microdescriptors makes Tor clients download less directory information, thus saving bandwidth. Directory caches need to fetch regular descriptors and microdescriptors, so this option doesn’t save any bandwidth for them. If this option is set to "auto" (recommended) then it is on for all clients that do not set FetchUselessDescriptors. (Default: auto)

If you read this example it reads as if FetchUselessDescriptiors is defaulted to auto (It's actually defaulted to zero) when it actually means to show that UseMicrodescriptors defaults to auto.

I think it would be clearer if the default was clearly seperated from the description body, maybe as a subheader for each option.

Child Tickets

Change History (4)

comment:1 Changed 6 years ago by sysrqb

Component: WebsiteTor

This sounds like an enhancement to Tor's man page.

comment:2 Changed 6 years ago by Ry

Yes sorry I forgot to link, I'm talking about here https://www.torproject.org/docs/tor-manual.html.en specifically. But yeah, I guess it is the man page.

comment:3 Changed 5 years ago by nickm

Milestone: Tor: unspecified

comment:4 Changed 2 years ago by nickm

Keywords: tor-relay docs defaults easy english style manpage added
Severity: Normal
Note: See TracTickets for help on using tickets.