[sr-dev] git:master:b4ab0fdc: siptrace: Update doc for the two new modparams

[Stefan Mititelu]

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

Author: Stefan Mititelu <stefan-cristian.mititelu at 1and1.ro>
Committer: Stefan Mititelu <stefan-cristian.mititelu at 1and1.ro>
Date: 2022-08-10T10:24:51+03:00

siptrace: Update doc for the two new modparams

---

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

---

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

---

diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml
index ec5a5da63c..430c35b4f8 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -656,6 +656,7 @@ modparam("siptrace", "evcb_msg", "ksr_siptrace_msg")
                 <title><varname>trace_dialog_ack</varname> (str)</title>
                 <para>
 			Enable tracing of in-dialog ACK.
+			Before this param, one must have set the onsend() route and captured the outgoing ACK there.
                 </para>
                 <para>
 			Default value is 1 (enabled).
@@ -674,6 +675,8 @@ modparam("siptrace", "trace_dialog_ack", 1)
                 <title><varname>trace_dialog_spiral</varname> (str)</title>
                 <para>
 			Enable tracing of dialog spirals.
+			A spiraled dialog is a dialog established by a SIP INVITE that loops back to the same kamailio(as next hop).
+			Right now, inside the siptrace code, a spiraled dialog is identified by (*params->param == NULL).
                 </para>
                 <para>
 			Default value is 1 (enabled).