[sr-dev] git:master:236c55d2: Merge pull request #449 from giavac/master

[Victor Seva]

Module: kamailio
Branch: master
Commit: 236c55d21f20c59353f963256907fe4ca35d2c19
URL: https://github.com/kamailio/kamailio/commit/236c55d21f20c59353f963256907fe4ca35d2c19

Author: Victor Seva <linuxmaniac at torreviejawireless.org>
Committer: Victor Seva <linuxmaniac at torreviejawireless.org>
Date: 2015-12-17T10:49:57+01:00

Merge pull request #449 from giavac/master

cfgt: doc improvements

---

Modified: modules/cfgt/README
Modified: modules/cfgt/doc/cfgt_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/236c55d21f20c59353f963256907fe4ca35d2c19.diff
Patch: https://github.com/kamailio/kamailio/commit/236c55d21f20c59353f963256907fe4ca35d2c19.patch

---

diff --git a/modules/cfgt/README b/modules/cfgt/README
index a3be5ff..3e2b606 100644
--- a/modules/cfgt/README
+++ b/modules/cfgt/README
@@ -10,7 +10,7 @@ Victor Seva
 
    <linuxmaniac at torreviejawireless.org>
 
-   Copyright © 2015 Victor Seva (sipwise.com)
+   Copyright © 2015 Victor Seva (sipwise.com)
      __________________________________________________________________
 
    Table of Contents
@@ -58,7 +58,7 @@ Chapter 1. Admin Guide
    SIP scenarios.
 
    In order to identify defferent scenarios a prefix string should be used
-   at Call-ID header.
+   inside the Call-ID header.
 
 2. Dependencies
 
@@ -84,10 +84,10 @@ Chapter 1. Admin Guide
 
 3.1. basedir (string)
 
-   Control where the config reports should be stored. The dir must exists
-   and Kamailio SIP Server Platform must have perms to write on it.
+   Control where the config reports should be stored. The dir must exist
+   and Kamailio SIP Server Platform must have permissions to write on it.
 
-   Default value is "/tmp".
+   Default value is “/tmp”.
 
    Example 1.1. Set cfgtrace parameter
 ...
@@ -104,7 +104,7 @@ modparam("cfgt", "basedir", "/var/run/kamailio/cfgtest")
      * 16 - dump DP_OTHER vars
      * 32 - dump ALL vars
 
-   Default value is "32" (ALL).
+   Default value is “32” (ALL).
 
    Example 1.2. Set mask parameter
 ...
@@ -115,9 +115,11 @@ modparam("cfgt", "mask", 12)
 3.3. callid_prefix (string)
 
    Prefix used to indentify test scenario messages. Last char of the
-   string will be used as delimiter.
+   string will be used as delimiter for the scenario ID. With parameter
+   set to “NGCP%” and Call-ID “NGCP%123%456” the scenario identified will
+   be “123”.
 
-   Default value is "NGCP%" (using "%" as delimiter).
+   Default value is “NGCP%” (using “%” as delimiter).
 
    Example 1.3. Set callid_prefix parameter
 ...
diff --git a/modules/cfgt/doc/cfgt_admin.xml b/modules/cfgt/doc/cfgt_admin.xml
index 07b8ea4..e507456 100644
--- a/modules/cfgt/doc/cfgt_admin.xml
+++ b/modules/cfgt/doc/cfgt_admin.xml
@@ -23,7 +23,7 @@
 	</para>
 	<para>
 		In order to identify defferent scenarios a prefix string should be
-		used at Call-ID header.
+		used inside the Call-ID header.
 	</para>
 	</section>
 	<section>
@@ -62,7 +62,7 @@
 		<title><varname>basedir</varname> (string)</title>
 		<para>
 			Control where the config reports should be stored. The dir must
-			exists and &kamailioname; must have perms to write on it.
+			exist and &kamailioname; must have permissions to write on it.
 		</para>
 		<para>
 		<emphasis>
@@ -126,7 +126,9 @@ modparam("cfgt", "mask", 12)
 		<title><varname>callid_prefix</varname> (string)</title>
 		<para>
 			Prefix used to indentify test scenario messages. Last char of the
-			string will be used as delimiter.
+			string will be used as delimiter for the scenario ID. With parameter
+			set to <quote>NGCP%</quote> and Call-ID <quote>NGCP%123%456</quote> 
+			the scenario identified will be <quote>123</quote>.
 		</para>
 		<para>
 		<emphasis>