[sr-dev] git:master:4b30a3c4: app_ruby: docs for xval_mode parameter

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-01-08T21:07:11+01:00

app_ruby: docs for xval_mode parameter

---

Modified: src/modules/app_ruby/doc/app_ruby_admin.xml

---

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

---

diff --git a/src/modules/app_ruby/doc/app_ruby_admin.xml b/src/modules/app_ruby/doc/app_ruby_admin.xml
index d69d4d880a..872c6cf0d6 100644
--- a/src/modules/app_ruby/doc/app_ruby_admin.xml
+++ b/src/modules/app_ruby/doc/app_ruby_admin.xml
@@ -85,7 +85,37 @@ modparam("app_ruby", "load", "/usr/local/etc/kamailio/ruby/myscript.rb")
 </programlisting>
 	    </example>
 	</section>
-
+	<section id="app_ruby.p.xval_mode">
+	    <title><varname>xval_mode</varname> (int)</title>
+	    <para>
+			Control if the external sub-module functions returning extended-values
+			should propagate their string return value (when set to 0) or be
+			replaced by NULL/nil (when set to 1).
+			</para>
+			<para>
+			When set to 0, the KSR::PV Ruby submodule is implemented with the
+			internal functions from the app_ruby module, otherwise the ones from
+			core are used.
+	    </para>
+	    <para>
+			Note: when set to 1, there were crashing reports that are under
+			investigation, this option being provided as intermediary
+			solution to preserve the behaviour from older versions.
+	    </para>
+	    <para>
+		<emphasis>
+		    Default value is <quote>0</quote>.
+		</emphasis>
+	    </para>
+	    <example>
+		<title>Set <varname>xval_mode</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("app_ruby", "xval_mode", 1)
+...
+</programlisting>
+	    </example>
+	</section>
 	</section>
 
     <section>