[sr-dev] git:master:6542a638: rr: docs - note about use of record_route() for requests within dialog

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-08-13T16:07:05+02:00

rr: docs - note about use of record_route() for requests within dialog

- it has to be used after loose_route() for a proper detection of
request direction

---

Modified: src/modules/rr/doc/rr_admin.xml

---

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

---

diff --git a/src/modules/rr/doc/rr_admin.xml b/src/modules/rr/doc/rr_admin.xml
index 74e59abe82..362edd4f1f 100644
--- a/src/modules/rr/doc/rr_admin.xml
+++ b/src/modules/rr/doc/rr_admin.xml
@@ -397,8 +397,7 @@ loose_route();
     </section>
 
     <section id="rr.f.record_route">
-      <title><function moreinfo="none">record_route()</function> and <function
-      moreinfo="none">record_route(string)</function></title>
+      <title><function moreinfo="none">record_route([sparams])</function></title>
 
       <para>The function adds a new Record-Route header field. The header
       field will be inserted in the message before any other Record-Route
@@ -414,6 +413,10 @@ loose_route();
       request and generate and add a flow-token as the username part of the
       Record-Route-URI.</para>
 
+      <para>Note: if append From-tag is enabled and the function is used for requests
+      within dialog, it must be executed after loose_route() in order to detect
+      properly the direction.</para>
+
       <para>This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
       FAILURE_ROUTE.</para>