From 6d7c4c6ec2f76512c1142c1cb4453967d3bc1661 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Thu, 29 Mar 2018 15:06:07 -0400 Subject: Remove erroneous section heading "ExitPolicyDefault" The anchor here was originally introduced to make sure that the manpage would format correctly, but we had mistaken it for a section anchor, and introduced a bogus section heading in 3563a2c8194ebe94. Fixes bug 25582; bugfix on 0.3.3.1-alpha. --- changes/bug25582 | 3 +++ doc/tor.1.txt | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 changes/bug25582 diff --git a/changes/bug25582 b/changes/bug25582 new file mode 100644 index 0000000000..609b94aac6 --- /dev/null +++ b/changes/bug25582 @@ -0,0 +1,3 @@ + o Minor bugfixes (documentation): + - Revert a misformatting issue in the ExitPolicy + documentation. Fixes bug 25582; bugfix on 0.3.3.1-alpha. diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 80769412f9..2c01a3ec99 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -1904,7 +1904,7 @@ is non-zero): reject *:6881-6999 accept *:* -[[ExitPolicyDefault]] **ExitPolicyDefault**:: +[[ExitPolicyDefault]]:: Since the default exit policy uses accept/reject *, it applies to both IPv4 and IPv6 addresses. -- cgit v1.2.3-54-g00ecf From ff38c0589ceab60cda9c27b117d1dcfef55b3539 Mon Sep 17 00:00:00 2001 From: David Goulet Date: Wed, 4 Apr 2018 11:38:42 -0400 Subject: man: Add a comment to anchor only option Some anchor don't appear in the final man page so document those so we understand why we do that in the future. Part of #25582 Signed-off-by: David Goulet --- doc/tor.1.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 2c01a3ec99..415cd6f3a0 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -1203,6 +1203,7 @@ The following options are useful only for clients (that is, if on different SocksPorts, TransPorts, etc are always isolated from one another. This option overrides that behavior.) +// Anchor only for formatting, not visible in the man page. [[OtherSocksPortFlags]]:: Other recognized __flags__ for a SocksPort are: **NoIPv4Traffic**;; @@ -1267,6 +1268,7 @@ The following options are useful only for clients (that is, if authentication" when IsolateSOCKSAuth is disabled, or when this option is set. +// Anchor only for formatting, not visible in the man page. [[SocksPortFlagsMisc]]:: Flags are processed left to right. If flags conflict, the last flag on the line is used, and all earlier flags are ignored. No error is issued for @@ -1904,6 +1906,7 @@ is non-zero): reject *:6881-6999 accept *:* +// Anchor only for formatting, not visible in the man page. [[ExitPolicyDefault]]:: Since the default exit policy uses accept/reject *, it applies to both IPv4 and IPv6 addresses. @@ -2079,6 +2082,7 @@ is non-zero): If the address is absent, or resolves to both an IPv4 and an IPv6 address, only listen to the IPv6 address. +// Anchor only for formatting, not visible in the man page. [[ORPortFlagsExclusive]]:: For obvious reasons, NoAdvertise and NoListen are mutually exclusive, and IPv4Only and IPv6Only are mutually exclusive. -- cgit v1.2.3-54-g00ecf