[tor-commits] [tor/master] Use RFC5737-compliant example IP addresses in manpage when describing MapAddress

[nickm at torproject.org]

commit 58cbe517084d4ec8cd4ff3c297f841e561804cc3
Author: rl1987 <rl1987 at sdf.lonestar.org>
Date:   Wed Jan 30 17:13:40 2019 +0200

    Use RFC5737-compliant example IP addresses in manpage when describing MapAddress
---
 changes/doc28623 |  3 +++
 doc/tor.1.txt    | 13 +++++++------
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/changes/doc28623 b/changes/doc28623
new file mode 100644
index 000000000..3c3313abd
--- /dev/null
+++ b/changes/doc28623
@@ -0,0 +1,3 @@
+  o Documentation:
+    - In manpage entry describing MapAddress torrc setting, use example
+      IP addresses from ranges specified by RFC 5737. Resolves issue 28623.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 00d6929c1..eb1603743 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1159,17 +1159,18 @@ The following options are useful only for clients (that is, if
 
     1. When evaluating MapAddress expressions Tor stops when it hits the most
     recently added expression that matches the requested address. So if you
-    have the following in your torrc, www.torproject.org will map to 1.1.1.1:
+    have the following in your torrc, www.torproject.org will map to
+    198.51.100.1:
 
-     MapAddress www.torproject.org 2.2.2.2
-     MapAddress www.torproject.org 1.1.1.1
+     MapAddress www.torproject.org 192.0.2.1
+     MapAddress www.torproject.org 198.51.100.1
 
     2. Tor evaluates the MapAddress configuration until it finds no matches. So
     if you have the following in your torrc, www.torproject.org will map to
-    2.2.2.2:
+    203.0.113.1:
 
-      MapAddress 1.1.1.1 2.2.2.2
-      MapAddress www.torproject.org 1.1.1.1
+      MapAddress 198.51.100.1 203.0.113.1
+      MapAddress www.torproject.org 198.51.100.1
 
     3. The following MapAddress expression is invalid (and will be
     ignored) because you cannot map from a specific address to a wildcard