[sr-dev] git:5.3:05a6f13c: siptrace: manual backport of 75e6e370ceb7, improve documentation for siptrace and DB setup

[Henning Westerholt]

Module: kamailio
Branch: 5.3
Commit: 05a6f13c40249e0d658016652ae46b8512149857
URL: https://github.com/kamailio/kamailio/commit/05a6f13c40249e0d658016652ae46b8512149857

Author: Henning Westerholt <hw at skalatan.de>
Committer: Henning Westerholt <hw at skalatan.de>
Date: 2020-06-05T10:29:10Z

siptrace: manual backport of 75e6e370ceb7, improve documentation for siptrace and DB setup

---

Modified: src/modules/siptrace/doc/siptrace_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/05a6f13c40249e0d658016652ae46b8512149857.diff
Patch: https://github.com/kamailio/kamailio/commit/05a6f13c40249e0d658016652ae46b8512149857.patch

---

diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml
index 6b3a1f49f8..f5be1c663c 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -522,7 +522,9 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
 		<para>
 		Store or forward the current processed SIP message/transaction/dialog in database.
 		It is stored in the form prior applying changes made to it. Based on mode, one can trace
-		the current message('m' - default), the current transaction('t') or the current dialog('d').
+		the current message('m'), the current transaction('t') or the current dialog('d').
+		If no mode is given, it falls back to the default mode - transaction tracking when
+		trace_flag is set, otherwise only the current message.
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
@@ -674,12 +676,12 @@ hlog("$hdr(P-MyID)", "Another one with a custom correlation ID");
 	<section>
 		<title>Database setup</title>
 		<para>
-		Before running &kamailio; with siptrace, you have to setup the database 
-		tables where the module will store the data. For that, if the
-		table were not created by the installation script or you choose
-		to install everything by yourself you can use the siptrace-create.sql
-		<acronym>SQL</acronym> script in the database directories in the
-		kamailio/scripts folder as template.
+		Before running &kamailio; with siptrace and activated trace_to_database
+		parameter, you have to setup the database tables where the module will
+		store the data. For that, if the table were not created by the
+		installation script or you choose to install everything by yourself
+		you can use the siptrace-create.sql <acronym>SQL</acronym> script in
+		the database directories in the kamailio/scripts folder as template.
 		You can also find the complete database documentation on the
 		project webpage, &kamailiodbdocslink;.
 		</para>