Skip to content

Commit

Permalink
Update documentation to include new usrloc_domain parameter.
Browse files Browse the repository at this point in the history
  • Loading branch information
charlesrchance committed Sep 26, 2016
1 parent b747d46 commit af2f500
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
16 changes: 16 additions & 0 deletions modules/dmq_usrloc/README
Expand Up @@ -31,12 +31,15 @@ Andrey Rybkin
3.3. batch_size (int)
3.4. batch_usleep (int)

4. usrloc_domain (string)

List of Examples

1.1. Set enable parameter
1.2. Set sync parameter
1.3. Set batch size parameter
1.4. Set batch_usleep parameter
1.5. Set usrloc_domain parameter

Chapter 1. Admin Guide

Expand All @@ -54,6 +57,8 @@ Chapter 1. Admin Guide
3.3. batch_size (int)
3.4. batch_usleep (int)

4. usrloc_domain (string)

1. Overview

The module adds user location (usrloc) records replication between
Expand Down Expand Up @@ -134,3 +139,14 @@ modparam("dmq_usrloc", "batch_size", 4000)
...
modparam("dmq_usrloc", "batch_usleep", 1000)
...

4. usrloc_domain (string)

The usrloc domain to synchronize.

Default value is “location”.

Example 1.5. Set usrloc_domain parameter
...
modparam("dmq_usrloc", "usrloc_domain", "my_domain")
...
20 changes: 20 additions & 0 deletions modules/dmq_usrloc/doc/dmq_usrloc_admin.xml
Expand Up @@ -179,5 +179,25 @@ modparam("dmq_usrloc", "batch_usleep", 1000)
</section>
</section>

<section id="usrloc_dmq.p.usrloc_domain">
<title><varname>usrloc_domain</varname> (string)</title>
<para>
The usrloc domain to synchronize.
</para>
<para>
<emphasis>
Default value is <quote>location</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>usrloc_domain</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dmq_usrloc", "usrloc_domain", "my_domain")
...
</programlisting>
</example>
</section>

</chapter>

0 comments on commit af2f500

Please sign in to comment.