Opened 6 years ago

Closed 5 years ago

#11061 closed defect (fixed)

SocksPort section of man page is mangled

Reported by: arma Owned by:
Priority: Medium Milestone: Tor: 0.2.5.x-final
Component: Core Tor/Tor Version:
Severity: Keywords: tor-client 024-backport
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Look at 'man tor' in 0.2.4.20 or master

Right around the "Other recognized _flags_ for a SOCKSPort are:" line things go bad.

Below is a diff that makes it somewhat better for me:

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index f2960af..1436cec 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -960,6 +960,7 @@ The following options are useful only for clients (that is, 
         another. This option overrides that behavior.) +
 +
     Other recognized _flags_ for a SOCKSPort are:
++
     **NoIPv4Traffic**;;
         Tell exits to not connect to IPv4 addresses in response to SOCKS
         requests on this connection.
@@ -977,6 +978,7 @@ The following options are useful only for clients (that is, 
        unauthenticated, so exposing it in this way could leak your
        information to anybody watching your network, and allow anybody
        to use your computer as an open proxy.
++
     **CacheIPv4DNS**;;
         Tells the client to remember IPv4 DNS answers we receive from exit
         nodes via this connection. (On by default.)

but "_flags_" is still weird, and also the indenting is still not perfect. Somebody who knows what formatting we actually want should look at this too.

Child Tickets

Change History (12)

comment:1 Changed 6 years ago by nickm

Keywords: 024-backport security added
Milestone: Tor: 0.2.4.x-finalTor: 0.2.5.x-final

comment:2 Changed 6 years ago by arma

To be clear, my patch above is an improvement I think, but it does not fully resolve the bug.

comment:3 Changed 6 years ago by nickm

Keywords: 025-triaged added

comment:4 Changed 6 years ago by nickm

Keywords: security 025-triaged removed
Milestone: Tor: 0.2.5.x-finalTor: 0.2.4.x-final
Status: newneeds_review

I think I have it fixed in bug11061_024, which I just merged into master. It's a potential backport.

(The only solution I could come up with was to use an anchor to make a dummy toplevel heading to make "Other recognized flags..." (note double-underlines) indent properly. Anybody who wants to hunt for a more elegant solution is most welcome to do so.)

comment:5 Changed 6 years ago by nickm

Recommendation: no backport. arma gave this as a canonical example of what not to backport.

comment:6 Changed 6 years ago by arma

no backport, it isn't hurting anybody (much)

comment:7 Changed 6 years ago by nickm

Milestone: Tor: 0.2.4.x-finalTor: 0.2.5.x-final

We seem to be agreed; no backport.

comment:8 Changed 6 years ago by nickm

Resolution: fixed
Status: needs_reviewclosed

hang on, this was supposed to get closed.

comment:9 Changed 5 years ago by ln5

Resolution: fixed
Status: closedreopened

comment:10 Changed 5 years ago by ln5

Status: reopenedneeds_review

The IP addr NOTE is misplaced.

Please see bug_11061 in my repo for a fix that looks good for me.

comment:11 Changed 5 years ago by rl1987

The above patch looks good to me. It puts the warning paragraph where it was supposed to be.

comment:12 Changed 5 years ago by nickm

Resolution: fixed
Status: needs_reviewclosed

Okay, merged. Thanks!

Note: See TracTickets for help on using tickets.