[sr-dev] git:master:42f42baf: app_perl: docs for parse_mode parameter

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2022-07-07T09:15:12+02:00

app_perl: docs for parse_mode parameter

---

Modified: src/modules/app_perl/doc/app_perl_admin.xml

---

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

---

diff --git a/src/modules/app_perl/doc/app_perl_admin.xml b/src/modules/app_perl/doc/app_perl_admin.xml
index 2a71c4bad6e..aad43c2348b 100644
--- a/src/modules/app_perl/doc/app_perl_admin.xml
+++ b/src/modules/app_perl/doc/app_perl_admin.xml
@@ -235,6 +235,30 @@ modparam("app_perl", "reset_cycles", 100000)
 ...
 modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
 ...
+</programlisting>
+			</example>
+		</section>
+
+		<section id="app_perl.p.parse_mode">
+			<title><varname>parse_mode</varname> (int)</title>
+			<para>
+			Control how to behave on perl_parse() return code - on some versions
+			it is the value for application exit and can break reloading.
+			</para>
+			<para>
+			If set to 0, continue even of perl_parse() returns non-zero, logging
+			a warning. If set to 1, realod fails on non-zero return code and
+			triggers an exit.
+			</para>
+			<para>
+			Default value is <emphasis>0</emphasis>.
+			</para>
+			<example>
+			<title>Set <varname>parse_mode</varname> parameter</title>
+			<programlisting format="linespecific">
+...
+modparam("app_perl", "parse_mode", 1)
+...
 </programlisting>
 			</example>
 		</section>