[sr-dev] git:master: kex: documentation updated with the new functions

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: 037336540926ef5b354a024aacacf55b005b577a
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=037336540926ef5b354a024aacacf55b005b577a

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Mon Mar  7 17:11:53 2011 +0100

kex: documentation updated with the new functions

- documented setdebug(level) and resetdebug()

---

 modules_k/kex/README            |   38 +++++++++++++++++++++++++++++++
 modules_k/kex/doc/kex_admin.xml |   47 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 85 insertions(+), 0 deletions(-)

diff --git a/modules_k/kex/README b/modules_k/kex/README
index f81977a..ea973c6 100644
--- a/modules_k/kex/README
+++ b/modules_k/kex/README
@@ -38,6 +38,8 @@ Daniel-Constantin Mierla
               3.10. isdsturiset()
               3.11. pv_printf(var, str)
               3.12. is_myself(uri)
+              3.13. setdebug(level)
+              3.14. resetdebug()
 
         4. Exported MI Functions
 
@@ -66,6 +68,8 @@ Daniel-Constantin Mierla
    1.10. >isdsturiset usage
    1.11. >pv_printf usage
    1.12. >is_myself usage
+   1.13. setdebug usage
+   1.14. >resetdebug usage
 
 Chapter 1. Admin Guide
 
@@ -91,6 +95,8 @@ Chapter 1. Admin Guide
         3.10. isdsturiset()
         3.11. pv_printf(var, str)
         3.12. is_myself(uri)
+        3.13. setdebug(level)
+        3.14. resetdebug()
 
    4. Exported MI Functions
 
@@ -141,6 +147,8 @@ Chapter 1. Admin Guide
    3.10. isdsturiset()
    3.11. pv_printf(var, str)
    3.12. is_myself(uri)
+   3.13. setdebug(level)
+   3.14. resetdebug()
 
 3.1. setsflag(flag)
 
@@ -351,6 +359,36 @@ if(is_myself("$fu")) {
 }
 ...
 
+3.13. setdebug(level)
+
+   Set the debug log level per process.
+
+   Meaning of the parameters is as follows:
+     * level - the debug log level to be set. Can be integer or
+       pseudo-variable with integer value.
+
+   This function can be used from ANY_ROUTE.
+
+   Example 1.13. setdebug usage
+...
+setdebug("1");
+...
+$var(level) = 2;
+setdebug("$var(level)");
+...
+
+3.14. resetdebug()
+
+   Reset the local debug log level back to the value of core parameter
+   'debug'.
+
+   This function can be used from ANY_ROUTE.
+
+   Example 1.14. >resetdebug usage
+...
+resetdebug();
+...
+
 4. Exported MI Functions
 
    4.1. arg
diff --git a/modules_k/kex/doc/kex_admin.xml b/modules_k/kex/doc/kex_admin.xml
index 6c65586..2be6267 100644
--- a/modules_k/kex/doc/kex_admin.xml
+++ b/modules_k/kex/doc/kex_admin.xml
@@ -407,6 +407,53 @@ if(is_myself("$fu")) {
 </programlisting>
 		</example>
 		</section>
+		<section>
+		<title><function moreinfo="none">setdebug(level)</function></title>
+		<para>
+			Set the debug log level per process.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+				<emphasis>level</emphasis> - the debug log level to
+				be set. Can be integer or pseudo-variable with integer value.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>setdebug</function> usage</title>
+		<programlisting format="linespecific">
+...
+setdebug("1");
+...
+$var(level) = 2;
+setdebug("$var(level)");
+...
+</programlisting>
+		</example>
+		</section>
+		<section>
+		<title><function moreinfo="none">resetdebug()</function></title>
+		<para>
+		Reset the local debug log level back to the value of core parameter
+		'debug'.
+		</para>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>>resetdebug</function> usage</title>
+		<programlisting format="linespecific">
+...
+resetdebug();
+...
+</programlisting>
+		</example>
+		</section>
 	</section>
 
 	<section>