[sr-dev] git:5.3:8922f773: rtpengine: docs updated for rtpengine_manage()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 5.3
Commit: 8922f7733e49c3bf39df0846ae2d1c74668b0e4f
URL: https://github.com/kamailio/kamailio/commit/8922f7733e49c3bf39df0846ae2d1c74668b0e4f

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-02-25T08:40:16+01:00

rtpengine: docs updated for rtpengine_manage()

(cherry picked from commit bdba22bb9b573c7b32a7de45154f9159c725715f)

---

Modified: src/modules/rtpengine/doc/rtpengine_admin.xml

---

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

---

diff --git a/src/modules/rtpengine/doc/rtpengine_admin.xml b/src/modules/rtpengine/doc/rtpengine_admin.xml
index 367d9bf7f9..d4cd2e4fc1 100644
--- a/src/modules/rtpengine/doc/rtpengine_admin.xml
+++ b/src/modules/rtpengine/doc/rtpengine_admin.xml
@@ -2560,7 +2560,7 @@ rtpengine_query();
         <function moreinfo="none">rtpengine_manage([flags])</function>
         </title>
 		<para>
-		Manage the RTPProxy session - it combines the functionality of
+		Manage the RTPEngine session - it combines the functionality of
 		rtpengine_offer(), rtpengine_answer() and rtpengine_delete(), detecting
 		internally based on message type and method which one to execute.
 		</para>
@@ -2597,7 +2597,14 @@ rtpengine_query();
 			this function after resuming a suspended transaction (e.g., after
 			t_continue()), because the context of executed route is FAILURE
 			ROUTE (in other words, rtpengine_manage() in the route block of
-			t_continue() does the same as in failure_route).
+			t_continue() does the same as in failure_route; use a branch route
+			to engage rtpengine for a forwarded branch after resuming the
+			transaction).
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			It does nothing if used inside event_route[tm:branch-failure:...]
 			</para>
 		</listitem>
 		<listitem>