[sr-dev] git:master:99a60151: dmq_usrloc: documentation for sync parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 99a6015165d161c4b99c72d81497e3496b387768
URL: https://github.com/kamailio/kamailio/commit/99a6015165d161c4b99c72d81497e3496b387768

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2015-11-20T12:33:19+01:00

dmq_usrloc: documentation for sync parameter

---

Modified: modules/dmq_usrloc/README
Modified: modules/dmq_usrloc/doc/dmq_usrloc_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/99a6015165d161c4b99c72d81497e3496b387768.diff
Patch: https://github.com/kamailio/kamailio/commit/99a6015165d161c4b99c72d81497e3496b387768.patch

---

diff --git a/modules/dmq_usrloc/README b/modules/dmq_usrloc/README
index c22b9fa..db19233 100644
--- a/modules/dmq_usrloc/README
+++ b/modules/dmq_usrloc/README
@@ -27,10 +27,12 @@ Andrey Rybkin
         3. Parameters
 
               3.1. enable (int)
+              3.2. sync (int)
 
    List of Examples
 
    1.1. Set enable parameter
+   1.2. Set sync parameter
 
 Chapter 1. Admin Guide
 
@@ -44,6 +46,7 @@ Chapter 1. Admin Guide
    3. Parameters
 
         3.1. enable (int)
+        3.2. sync (int)
 
 1. Overview
 
@@ -63,6 +66,7 @@ Chapter 1. Admin Guide
 3. Parameters
 
    3.1. enable (int)
+   3.2. sync (int)
 
 3.1. enable (int)
 
@@ -77,3 +81,17 @@ Chapter 1. Admin Guide
 ...
 modparam("dmq_usrloc", "enable", 1)
 ...
+
+3.2. sync (int)
+
+   The parameter controls whetner to request synchronization of all usrloc
+   records at startup. The value can be:
+     * 0 - disabled
+     * 1 - enabled
+
+   Default value is 1.
+
+   Example 1.2. Set sync parameter
+...
+modparam("dmq_usrloc", "sync", 0)
+...
diff --git a/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml b/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml
index abd529d..a7da61d 100644
--- a/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml
+++ b/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml
@@ -75,6 +75,39 @@ modparam("dmq_usrloc", "enable", 1)
 </programlisting>
 	</example>
 	</section>
+	<section id="usrloc_dmq.p.sync">
+		<title><varname>sync</varname> (int)</title>
+		<para>
+			The parameter controls whetner to request synchronization of all
+			usrloc records at startup.
+			The value can be:
+			<itemizedlist>
+			<listitem>
+			<para>
+				0 - disabled
+			</para>
+			</listitem>
+			<listitem>
+			<para>
+				1 - enabled
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+		<para>
+		<emphasis>
+			Default value is 1.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>sync</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("dmq_usrloc", "sync", 0)
+...
+</programlisting>
+	</example>
+	</section>
 	</section>
 
 </chapter>