Opened 8 years ago

Closed 8 years ago

Last modified 7 years ago

#4012 closed defect (fixed)

Document all torrc options

Reported by: arma Owned by:
Priority: High Milestone: Tor: 0.2.3.x-final
Component: Core Tor/Tor Version: Tor: 0.2.3.3-alpha
Severity: Keywords: tor-client
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

doc/tor.1.txt doesn't include any mention of usemicrodescriptors.

I wonder if there are any other config options we've missed recently too.

Child Tickets

Change History (12)

comment:1 Changed 8 years ago by arma

make check-docs tells me

Not in man page: ClientTransportPlugin MaxClientCircuitsPending SocksListenAddress
UseMicrodescriptors _UseFilteringSSLBufferevents _UsingTestNetworkDefaults
__AllDirActionsPrivate __DisablePredictedCircuits __HashedControlSessionPassword
__LeaveStreamsUnattached __OwningControllerProcess __ReloadTorrcOnSIGHUP

The first four of those look most interesting.

comment:2 Changed 8 years ago by asn

I pushed an attempt to document ClientTransportPlugin to a branch named 'bug4012_clienttransportplugin' in git://gitorious.org/mytor/mytor.git

Please check it out and suggest improvements.

comment:3 in reply to:  2 Changed 8 years ago by nickm

Replying to asn:

I pushed an attempt to document ClientTransportPlugin to a branch named 'bug4012_clienttransportplugin' in git://gitorious.org/mytor/mytor.git

Please check it out and suggest improvements.

I went and merged it instead. :)

comment:4 Changed 8 years ago by rransom

Priority: normalmajor

comment:5 Changed 8 years ago by nickm

Status: newneeds_review
Summary: usemicrodescriptors not in 0.2.3.x man pageDocument all torrc options

See branch "bug4012_022" and branch "bug4012_023", both in my public repository, for merge into the corresponding branches.

comment:6 Changed 8 years ago by nickm

We will still need documentation for ServerTransportPlugin

comment:7 in reply to:  6 Changed 8 years ago by asn

Replying to nickm:

We will still need documentation for ServerTransportPlugin

And also documentation for both external and managed mode of {Server,Client}TransportPlugin.

I'll try to hack something up. Seems tricky!

comment:8 Changed 8 years ago by nickm

Merged my bug4012_02* branches as mentioned above, with fixes from arma.

comment:9 Changed 8 years ago by asn

See branch bug4012_servertransportplugin in https://git.gitorious.org/mytor/mytor.git, for an attempt to document ServerTransportPlugin and the managed proxy version of ClientTransportPlugin. It might need some better phrasing.

comment:10 Changed 8 years ago by nickm

Resolution: fixed
Status: needs_reviewclosed

Merged it; thanks!

comment:11 Changed 7 years ago by nickm

Keywords: tor-client added

comment:12 Changed 7 years ago by nickm

Component: Tor ClientTor
Note: See TracTickets for help on using tickets.