[tor-commits] [tor/master] Try to improve documentation for DirAuthority's port field.

[nickm at torproject.org]

commit 42e787817cc78aba714bed683f8a7a9efd7d4f30
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Jul 5 12:58:51 2017 -0400

    Try to improve documentation for DirAuthority's port field.
    
    Closes ticket 20152
---
 changes/doc20152 | 3 +++
 doc/tor.1.txt    | 8 +++++---
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/changes/doc20152 b/changes/doc20152
new file mode 100644
index 000000000..8b044e56d
--- /dev/null
+++ b/changes/doc20152
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Improve the documentation for the directory port part of the
+      DirAuthority line. Closes ticket 20152.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index f0b7fa8e4..2f4337630 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -436,9 +436,11 @@ GENERAL OPTIONS
     authority is listening for IPv6 connections on the indicated IPv6 address
     and OR Port. +
  +
-    Tor will contact the authority at __address__:__port__ (the DirPort) to
-    download directory documents. If an IPv6 address is supplied, Tor will
-    also download directory documents at the IPv6 address on the DirPort. +
+    Tor will contact the authority at __address__ to
+    download directory documents. The provided __port__ value is a dirport;
+    clients ignore this in favor of the specified "orport=" value.  If an
+    IPv6 address is supplied, Tor will
+    also download directory documents at the IPv6 address on the ORPort. +
  +
     If no **DirAuthority** line is given, Tor will use the default directory
     authorities. NOTE: this option is intended for setting up a private Tor