[sr-dev] git:master:806e0fa1: cfgt: extended documentation

Giacomo Vacca giacomo.vacca at gmail.com
Fri Dec 18 10:12:38 CET 2015


Module: kamailio
Branch: master
Commit: 806e0fa1f970062bee25d95e33058363735c3bba
URL: https://github.com/kamailio/kamailio/commit/806e0fa1f970062bee25d95e33058363735c3bba

Author: Giacomo Vacca <giacomo.vacca at gmail.com>
Committer: Giacomo Vacca <giacomo.vacca at gmail.com>
Date: 2015-12-17T17:03:18Z

cfgt: extended documentation

- Add a Usage part with .cfg example

---

Modified: modules/cfgt/doc/cfgt_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/806e0fa1f970062bee25d95e33058363735c3bba.diff
Patch: https://github.com/kamailio/kamailio/commit/806e0fa1f970062bee25d95e33058363735c3bba.patch

---

diff --git a/modules/cfgt/doc/cfgt_admin.xml b/modules/cfgt/doc/cfgt_admin.xml
index 4282d7d..510b636 100644
--- a/modules/cfgt/doc/cfgt_admin.xml
+++ b/modules/cfgt/doc/cfgt_admin.xml
@@ -148,13 +148,31 @@ 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
+# ----- 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>




More information about the sr-dev mailing list