[sr-dev] git:master: topoh: documentation updated for mask_ip parameter

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: a35f99d0bceeb49edc0ebe782fad04db8476f3d9
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a35f99d0bceeb49edc0ebe782fad04db8476f3d9

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Wed Sep 10 20:16:31 2014 +0200

topoh: documentation updated for mask_ip parameter

---

 modules/topoh/README              |    9 +++++----
 modules/topoh/doc/topoh_admin.xml |    7 ++++---
 2 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/modules/topoh/README b/modules/topoh/README
index 4783f9d..6895a33 100644
--- a/modules/topoh/README
+++ b/modules/topoh/README
@@ -128,11 +128,12 @@ modparam("topoh", "mask_key", "some secret here")
 3.2. mask_ip (str)
 
    IP address to be used in masked headers to build valid SIP URIs. Can be
-   any IP address, even a private-space IP address (e.g., 192.168.1.1),
-   but must not be SIP server's local IP address. It is not used at all
-   for SIP routing.
+   any IP address, even a private-space or non-existing IP address (e.g.,
+   192.168.1.1, 127.0.0.2), including the SIP server address, but must not
+   be an address potentially used by clients. It is not used at all for
+   SIP routing.
 
-   Default value is "10.1.1.10".
+   Default value is "127.0.0.8".
 
    Example 1.2. Set mask_ip parameter
 ...
diff --git a/modules/topoh/doc/topoh_admin.xml b/modules/topoh/doc/topoh_admin.xml
index 66719ee..f932b3e 100644
--- a/modules/topoh/doc/topoh_admin.xml
+++ b/modules/topoh/doc/topoh_admin.xml
@@ -89,13 +89,14 @@ modparam("topoh", "mask_key", "some secret here")
 		<title><varname>mask_ip</varname> (str)</title>
 		<para>
 		IP address to be used in masked headers to build valid
-		SIP URIs. Can be any IP address, even a private-space IP address
-		(e.g., 192.168.1.1), but must not be SIP server's local IP address.
+		SIP URIs. Can be any IP address, even a private-space or non-existing
+		IP address (e.g., 192.168.1.1, 127.0.0.2), including the SIP server
+		address, but must not be an address potentially used by clients.
 		It is not used at all for SIP routing.
 		</para>
 		<para>
 		<emphasis>
-			Default value is "10.1.1.10".
+			Default value is "127.0.0.8".
 		</emphasis>
 		</para>
 		<example>