Merge pull request #450 from giavac/master

cfgt: second pass at documentation update

modules/cfgt/README

@@ -29,6 +29,8 @@ Victor Seva
               3.2. mask (int)
               3.3. callid_prefix (string)
 
+        4. Usage
+
    List of Examples
 
    1.1. Set cfgtrace parameter
@@ -51,13 +53,15 @@ Chapter 1. Admin Guide
         3.2. mask (int)
         3.3. callid_prefix (string)
 
+   4. Usage
+
 1. Overview
 
    This module provides a report of the way Kamailio SIP Server Platform
    configuration has been executed as part of a unit test for different
    SIP scenarios.
 
-   In order to identify defferent scenarios a prefix string should be used
+   In order to identify different scenarios a prefix string should be used
    inside the Call-ID header.
 
 2. Dependencies
@@ -114,10 +118,10 @@ 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 for the scenario ID. With parameter
-   set to “NGCP%” and Call-ID “NGCP%123%456” the scenario identified will
-   be “123”.
+   Prefix used to identify test scenario messages. Last char of the 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).
 
@@ -126,3 +130,30 @@ modparam("cfgt", "mask", 12)
 # using '%' as delimiter
 modparam("cfgt", "callid_prefix", "TEST-ID%")
 ...
+
+4. Usage
+
+   This module is used by the debugger module, so it must be loaded first.
+   To enable the generation of the reports, the debugger module must be
+   configured by setting the cfgtest parameter to "1".
+
+   Example of configuration:
+...
+#!ifdef WITH_DEBUG
+loadmodule "cfgt.so"
+loadmodule "debugger.so"
+#!endif
+...
+#!ifdef WITH_DEBUG
+# ----- cfgt params -----
+modparam("cfgt", "basedir", "/tmp/kamailio/cfgtest")
+modparam("cfgt", "callid_prefix", "TRACE-ID%")
+modparam("cfgt", "mask", 32)
+
+# ----- debugger params -----
+modparam("debugger", "cfgtrace", 1)
+modparam("debugger", "log_level_name", "exec")
+
+modparam("debugger", "cfgtest", 1)
+#!endif
+...

modules/cfgt/doc/cfgt_admin.xml

@@ -22,7 +22,7 @@
 		SIP scenarios.
 	</para>
 	<para>
-		In order to identify defferent scenarios a prefix string should be
+		In order to identify different scenarios a prefix string should be
 		used inside the Call-ID header.
 	</para>
 	</section>
@@ -125,7 +125,7 @@ modparam("cfgt", "mask", 12)
 	<section id="cfgt.p.callid_prefix">
 		<title><varname>callid_prefix</varname> (string)</title>
 		<para>
-			Prefix used to indentify test scenario messages. Last char of the
+			Prefix used to identify test scenario messages. Last char of the
 			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>.
@@ -148,13 +148,36 @@ modparam("cfgt", "callid_prefix", "TEST-ID%")
 	</section>
 
 	</section>
-
-<!--
 	<section>
 		<title>Usage</title>
 		<para>
-			TODO: add some more info of how this is been used
+		This module is used by the <emphasis>debugger</emphasis> module, so it must be loaded
+		first. To enable the generation of the reports, the <emphasis>debugger</emphasis> module
+		must be configured by setting the <emphasis>cfgtest</emphasis> parameter to "1".
 		</para>
-	</section>
--->
+		<para>
+		Example of configuration:
+		</para>
+<programlisting  format="linespecific">
+...
+#!ifdef WITH_DEBUG
+loadmodule "cfgt.so"
+loadmodule "debugger.so"
+#!endif
+...
+#!ifdef WITH_DEBUG
+# ----- cfgt params -----
+modparam("cfgt", "basedir", "/tmp/kamailio/cfgtest")
+modparam("cfgt", "callid_prefix", "TRACE-ID%")
+modparam("cfgt", "mask", 32)
+
+# ----- debugger params -----
+modparam("debugger", "cfgtrace", 1)
+modparam("debugger", "log_level_name", "exec")
+
+modparam("debugger", "cfgtest", 1)
+#!endif
+...
+</programlisting>
+    </section>
 </chapter>