[sr-dev] git:master:e4dfe358: dialog: docs - more info about using the flag and dlg_manage()

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-01-09T09:50:12+01:00

dialog: docs - more info about using the flag and dlg_manage()

---

Modified: src/modules/dialog/doc/dialog_admin.xml

---

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

---

diff --git a/src/modules/dialog/doc/dialog_admin.xml b/src/modules/dialog/doc/dialog_admin.xml
index ca0109b31f..9adca735db 100644
--- a/src/modules/dialog/doc/dialog_admin.xml
+++ b/src/modules/dialog/doc/dialog_admin.xml
@@ -45,9 +45,10 @@
 	<section>
 	<title>How it works</title>
 	<para>
-	To create the dialog associated with an initial request, the flag
-	<quote>dlg_flag</quote> (<xref linkend="dialog.p.flag"/>) must be set before
-	creating the corresponding transaction.
+	To create the dialog associated with an initial INVITE request, execute
+	the function <quote>dlg_manage()</quote> or set the flag specified by
+	parameter <quote>dlg_flag</quote> (<xref linkend="dialog.p.flag"/>)
+	before creating the corresponding transaction.
 	</para>
 	<para>
 	The dialog is automatically destroyed when a <quote>BYE</quote> is
@@ -256,6 +257,12 @@ modparam("dialog", "rr_param", "xyz")
 		current request (this make sense only for initial requests).
 		</para>
 		<para>
+		Note: it is not needed to set this parameter and its corresponding flag
+		for initial request in case the <quote>dlg_manage()</quote> function
+		is used. In other words, using <quote>dlg_manage()</quote> alone is
+		enough.
+		</para>
+		<para>
 		<emphasis>
 			Default value is <quote>none</quote>.
 		</emphasis>