`make check-docs` return fake errors on tor-0.4.6.0-alpha-dev
Running make check-docs
on tor-0.4.6.0-alpha-dev generate some "missing anchor" :
make all-am
make[1]: Entering directory '[scrubbed]/tor-master'
make[1]: Leaving directory '[scrubbed]/tor-master'
perl ./scripts/maint/checkOptionDocs.pl
Missing an anchor: ClientTransportPlugin
Missing an anchor: SocksPort
Missing an anchor: NATDPort
Missing an anchor: after
Orphaned in torrc.sample.in: SOCKSPolicy SOCKSPort
[...]
There is 4 missing anchor. They are false positifs. They are only options description text that are in bold and are at the beginning of a line. Here is git diff HEAD
to solve those annoying false positives :
diff --git a/doc/man/tor.1.txt b/doc/man/tor.1.txt
index f5dd1ec..387ce82 100644
--- a/doc/man/tor.1.txt
+++ b/doc/man/tor.1.txt
@@ -61,8 +61,8 @@ NOTE: Configuration options on the command line override those in
configuration files. See **<<conf-format,THE CONFIGURATION FILE
FORMAT>>** for more information.
-The following options in this section are only recognized on the
-**`tor`** command line, not in a configuration file.
+The following options in this section are only recognized on the **`tor`**
+command line, not in a configuration file.
[[opt-h]] **`-h`**, **`--help`**::
Display a short help message and exit.
@@ -334,8 +334,9 @@ forward slash (/) in the configuration file and on the command line.
as a float value. This is an advanced option; you generally shouldn't have
to mess with it. (Default: -1)
-[[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
-**ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
+[[ClientTransportPlugin1]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__ +
+
+[[ClientTransportPlugin2]] **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
In its first form, when set along with a corresponding Bridge line, the Tor
client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT".
(IPv4 addresses should written as-is; IPv6 addresses should be wrapped in
@@ -1043,9 +1044,8 @@ forward slash (/) in the configuration file and on the command line.
// These options are in alphabetical order, with exceptions as noted.
// Please keep them that way!
-The following options are useful only for clients (that is, if
-**SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**, or
-**NATDPort** is non-zero):
+The following options are useful only for clients (that is, if **SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**,
+or **NATDPort** is non-zero):
[[AllowNonRFC953Hostnames]] **AllowNonRFC953Hostnames** **0**|**1**::
When this option is disabled, Tor blocks hostnames containing illegal
@@ -3224,8 +3224,8 @@ on the public Tor network.
The following options are used to configure a hidden service. Some options
apply per service and some apply for the whole tor instance.
-The next section describes the per service options that can only be set
-**after** the **HiddenServiceDir** directive
+The next section describes the per service options that can only be set **after**
+the **HiddenServiceDir** directive
**PER SERVICE OPTIONS:**