[sr-dev] git:master:a26a65ef: evrexec: notes about usage of modules with KEMI scripts

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2017-04-12T21:15:30+02:00

evrexec: notes about usage of modules with KEMI scripts

---

Modified: src/modules/evrexec/doc/evrexec_admin.xml

---

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

---

diff --git a/src/modules/evrexec/doc/evrexec_admin.xml b/src/modules/evrexec/doc/evrexec_admin.xml
index 840399e..b624eed 100644
--- a/src/modules/evrexec/doc/evrexec_admin.xml
+++ b/src/modules/evrexec/doc/evrexec_admin.xml
@@ -16,8 +16,9 @@
 	<section>
 	<title>Overview</title>
 	<para>
-		The module executes even route blocks once on dedicated processes. The
-		execution can be delayed for an interval of time.
+		The module executes event route blocks or KEMI functions on dedicated
+		processes at startup. The execution can be delayed for a specified
+		interval of time.
 	</para>
 	<para>
 		The actions in the event route should be a loop or other tasks that
@@ -77,6 +78,10 @@
 		<listitem>
 		<para>
 			<emphasis>name</emphasis> - name of the event route to be executed.
+			When used with a KEMI embedded laguage, this has to be the name
+			of a function from the KEMI script. The function must have a
+			string parameter, which will retrieve the index of the works in
+			string format.
 		</para>
 		</listitem>
 		<listitem>