[sr-dev] git:master:45989d3c: dispatcher: updated the example of destinations list file

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 45989d3c53242f8f5f29229333617c7bc00fd3ac
URL: https://github.com/kamailio/kamailio/commit/45989d3c53242f8f5f29229333617c7bc00fd3ac

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2017-05-19T14:58:07+02:00

dispatcher: updated the example of destinations list file

---

Modified: src/modules/dispatcher/doc/dispatcher.list
Modified: src/modules/dispatcher/doc/dispatcher_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/45989d3c53242f8f5f29229333617c7bc00fd3ac.diff
Patch: https://github.com/kamailio/kamailio/commit/45989d3c53242f8f5f29229333617c7bc00fd3ac.patch

---

diff --git a/src/modules/dispatcher/doc/dispatcher.list b/src/modules/dispatcher/doc/dispatcher.list
index 25e9c6ebf2..03fbb4e491 100644
--- a/src/modules/dispatcher/doc/dispatcher.list
+++ b/src/modules/dispatcher/doc/dispatcher.list
@@ -1,15 +1,15 @@
-# $Id$
-# dispatcher destination sets
+#
+# dispatcher destination sets (groups)
 #
 
 # line format
-# setit(int) destination(sip uri) flags(int,opt) priority(int,opt) attributes(str,opt)
+# setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attributes(str,opt)
 
 # proxies
-2 sip:127.0.0.1:5080
-2 sip:127.0.0.1:5082
+2 sip:127.0.0.1:5080;transport=tcp 0 10 class=4;prefix=448;strip=2
+2 sip:127.0.0.1:5082;px=vx 0 5 duid=abc;socket=udp:192.168.0.125:5060;pipe=p10
 
 # gateways
-1 sip:127.0.0.1:7070
-1 sip:127.0.0.1:7072
+1 sip:127.0.0.1:7070 0 0 duid=xyz;maxload=20
+1 sip:127.0.0.1:7072 0 5
 1 sip:127.0.0.1:7074
diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml
index ab40fb5f00..b5315acc2d 100644
--- a/src/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/src/modules/dispatcher/doc/dispatcher_admin.xml
@@ -77,7 +77,7 @@
 	<section id="dispatcher.p.list_file">
 		<title><varname>list_file</varname> (string)</title>
 		<para>
-		Path to the file with destination sets.
+		Path to the file with destination sets (destination groups).
 		</para>
 		<para>
 		<emphasis>
@@ -98,7 +98,7 @@ modparam("dispatcher", "list_file", "/var/run/kamailio/dispatcher.list")
 	<section id="dispatcher.p.db_url">
  		<title><varname>db_url</varname> (string)</title>
  		<para>
-		If you want to load the sets of gateways from the database you must set
+		If you want to load the list of gateways from the database you must set
 		this parameter.
  		</para>
  		<para>
@@ -119,7 +119,7 @@ modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database")
 	<section id="dispatcher.p.table_name">
 		<title><varname>table_name</varname> (string)</title>
 		<para>
-		If you want to load the sets of gateways from the database you must set
+		If you want to load the list of gateways from the database you must set
 		this parameter as the database name.
 		</para>
 		<para>
@@ -140,7 +140,8 @@ modparam("dispatcher", "table_name", "my_dispatcher")
 	<section id="dispatcher.p.setid_col">
 		<title><varname>setid_col</varname> (string)</title>
 		<para>
-			The column's name in the database storing the gateway's group id.
+			The column's name in the database storing the gateway's set (group)
+			id.
 		</para>
 		<para>
 		<emphasis>
@@ -1524,8 +1525,8 @@ onreply_route {
 		<title>Destination List File</title>
 		<para>
 		Each destination point must be on one line. First token is the set
-		id (an integer value), followed by destination address
-		(s string value in SIP URI format).
+		id (an integer value, also referenced by group id), followed by
+		destination address (string value in full SIP URI format).
 		</para>
 		<para>
 		Optionally, these fields can be followed by: