[tor-commits] [tor/master] Fix SOCKSPort documentation layout

[nickm at torproject.org]

commit 5e9672904c6d5ef24d497ff20d0b4f713d02ae5a
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Mar 25 09:59:19 2014 -0400

    Fix SOCKSPort documentation layout
    
    In the end this required a slightly nasty hack using a dummy anchor as
    an option heading in order to make the "Other recognized __flags__"
    line indent properly.
    
    Fixes bug 11061; Bugfix on 61d740ed.
---
 changes/bug11061 |    3 +++
 doc/tor.1.txt    |   22 ++++++++++++----------
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/changes/bug11061 b/changes/bug11061
new file mode 100644
index 0000000..5035e87
--- /dev/null
+++ b/changes/bug11061
@@ -0,0 +1,3 @@
+  o Documentation fixes:
+    - Fix the layout of the SOCKSPort flags in the manpage. Fixes bug
+      11061; bugfix on 0.2.4.7-alpha.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 3f8f6da..bc6303c 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -928,9 +928,10 @@ The following options are useful only for clients (that is, if
         on this port to share circuits with streams from every other
         port with the same session group.  (By default, streams received
         on different SOCKSPorts, TransPorts, etc are always isolated from one
-        another. This option overrides that behavior.) +
-+
-    Other recognized _flags_ for a SOCKSPort are:
+        another. This option overrides that behavior.)
+
+[[OtherSOCKSPortFlags]]::
+    Other recognized __flags__ for a SOCKSPort are:
     **NoIPv4Traffic**;;
         Tell exits to not connect to IPv4 addresses in response to SOCKS
         requests on this connection.
@@ -941,13 +942,14 @@ The following options are useful only for clients (that is, if
     **PreferIPv6**;;
         Tells exits that, if a host has both an IPv4 and an IPv6 address,
         we would prefer to connect to it via IPv6. (IPv4 is the default.) +
-+
-       NOTE: Although this option allows you to specify an IP address
-       other than localhost, you should do so only with extreme caution.
-       The SOCKS protocol is unencrypted and (as we use it)
-       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.
+ +
+        NOTE: Although this option allows you to specify an IP address
+        other than localhost, you should do so only with extreme caution.
+        The SOCKS protocol is unencrypted and (as we use it)
+        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.)