[sr-dev] git:master:4ff2c48d: registrar: update documentation to include path_check_local parameter

[Charles Chance]

Module: kamailio
Branch: master
Commit: 4ff2c48d66a3bce2c491b44d0f1b5e939e5508ff
URL: https://github.com/kamailio/kamailio/commit/4ff2c48d66a3bce2c491b44d0f1b5e939e5508ff

Author: Charles Chance <charles.chance at sipcentric.com>
Committer: Charles Chance <charles.chance at sipcentric.com>
Date: 2015-01-09T17:22:59Z

registrar: update documentation to include path_check_local parameter

---

Modified: modules/registrar/doc/registrar_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/4ff2c48d66a3bce2c491b44d0f1b5e939e5508ff.diff
Patch: https://github.com/kamailio/kamailio/commit/4ff2c48d66a3bce2c491b44d0f1b5e939e5508ff.patch

---

diff --git a/modules/registrar/doc/registrar_admin.xml b/modules/registrar/doc/registrar_admin.xml
index c7d5b98..f1c9dc5 100644
--- a/modules/registrar/doc/registrar_admin.xml
+++ b/modules/registrar/doc/registrar_admin.xml
@@ -630,6 +630,32 @@ modparam("registrar", "path_use_received", 1)
 		</example>
 	</section>
 
+	<section id="registrar.p.path_check_local">
+		<title><varname>path_check_local</varname> (integer)</title>
+		<para>
+		If set to 1, when performing a lookup the Path (if present) is evaluated
+		and if the first hop is local (according to <quote>myself</quote> test), we
+		skip it	to avoid unnecessary looping.
+		</para>
+		<para>
+		This is useful if multiple servers are sharing a common location database,
+		each saving contacts with their local address as the Path.
+		</para>
+		<para>
+		<emphasis>
+		Default value is 0 (disabled).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>path_check_local</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("registrar", "path_check_local", 1)
+...
+		</programlisting>
+		</example>
+	</section>
+
 	<section id="registrar.p.reg_callid_avp">
 		<title><varname>reg_callid_avp</varname> (string)</title>
 		<para>