[sr-dev] git:master:244eb42c: siptrace: document usage of trace_info xavp to prevent overlapping

[Henning Westerholt]

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

Author: iionita <ionut-razvan.ionita at 1and1.ro>
Committer: Henning Westerholt <henningw at users.noreply.github.com>
Date: 2019-05-28T21:56:25+02:00

siptrace: document usage of trace_info xavp to prevent overlapping

---

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

---

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

---

diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml
index b3cb739130..0ec443ce3a 100644
--- a/src/modules/siptrace/doc/siptrace_admin.xml
+++ b/src/modules/siptrace/doc/siptrace_admin.xml
@@ -662,6 +662,11 @@ hlog("$hdr(P-MyID)", "Another one with a custom correlation ID");
 	case of internal timeouts) won't be traced. At the moment kamailio offers
 	no posibility to trace those messages.
 	</para>
+	<para>
+		<emphasis>Trace_info</emphasis> xavp name is reserved by this module.
+		Any use of xavp with this name will result in overlapping internal
+		avp used by the module therefore causing unknown consequences.
+	</para>
 	<example>
 	<title>Send relayed ACK message</title>
 	<programlisting format="linespecific">