git:master: kex Fix copy/paste typos and minor edits for readability - sr-dev

8 Feb 2013

Module: sip-router
Branch: master
Commit: 3ce0e28280d4b7a5f4b991af861455114b829976
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=3ce0e282...
Author: Olle E. Johansson oej@edvina.net
Committer: Olle E. Johansson oej@edvina.net
Date:   Fri Feb  8 21:12:52 2013 +0100
kex Fix copy/paste typos and minor edits for readability
---
modules/kex/README            |   92 ++++++++++++++++++++--------------------
 modules/kex/doc/kex_admin.xml |   29 +++++++------
 2 files changed, 61 insertions(+), 60 deletions(-)

diff --git a/modules/kex/README b/modules/kex/README
index 7e94555..0a8f5ff 100644
--- a/modules/kex/README
+++ b/modules/kex/README
@@ -31,15 +31,15 @@ Daniel-Constantin Mierla
               3.3. resetsflag(flag)
               3.4. setbflag(flag [, branch])
               3.5. isbflagset(flag [, branch])
-              3.6. resetsflag(flag [, branch])
-              3.7. km_append_branch([uri])
-              3.8. setdsturi(uri)
-              3.9. resetdsturi()
-              3.10. isdsturiset()
-              3.11. pv_printf(var, str)
-              3.12. is_myself(uri)
-              3.13. setdebug(level)
-              3.14. resetdebug()
+              3.6. resetbflag(flag [, branch])
+              3.7. setdsturi(uri)
+              3.8. resetdsturi()
+              3.9. isdsturiset()
+              3.10. pv_printf(var, str)
+              3.11. is_myself(uri)
+              3.12. setdebug(level)
+              3.13. resetdebug()
+              3.14. km_append_branch([uri])
4. MI Commands
@@ -64,7 +64,7 @@ Daniel-Constantin Mierla
    1.3. resetsflag usage
    1.4. setbflag usage
    1.5. setbflag usage
-   1.6. resetsflag usage
+   1.6. resetbflag usage
    1.7. setdsturi usage
    1.8. resetdsturi usage
    1.9. isdsturiset usage
@@ -90,15 +90,15 @@ Chapter 1. Admin Guide
         3.3. resetsflag(flag)
         3.4. setbflag(flag [, branch])
         3.5. isbflagset(flag [, branch])
-        3.6. resetsflag(flag [, branch])
-        3.7. km_append_branch([uri])
-        3.8. setdsturi(uri)
-        3.9. resetdsturi()
-        3.10. isdsturiset()
-        3.11. pv_printf(var, str)
-        3.12. is_myself(uri)
-        3.13. setdebug(level)
-        3.14. resetdebug()
+        3.6. resetbflag(flag [, branch])
+        3.7. setdsturi(uri)
+        3.8. resetdsturi()
+        3.9. isdsturiset()
+        3.10. pv_printf(var, str)
+        3.11. is_myself(uri)
+        3.12. setdebug(level)
+        3.13. resetdebug()
+        3.14. km_append_branch([uri])
4. MI Commands
@@ -145,15 +145,15 @@ Chapter 1. Admin Guide
    3.3. resetsflag(flag)
    3.4. setbflag(flag [, branch])
    3.5. isbflagset(flag [, branch])
-   3.6. resetsflag(flag [, branch])
-   3.7. km_append_branch([uri])
-   3.8. setdsturi(uri)
-   3.9. resetdsturi()
-   3.10. isdsturiset()
-   3.11. pv_printf(var, str)
-   3.12. is_myself(uri)
-   3.13. setdebug(level)
-   3.14. resetdebug()
+   3.6. resetbflag(flag [, branch])
+   3.7. setdsturi(uri)
+   3.8. resetdsturi()
+   3.9. isdsturiset()
+   3.10. pv_printf(var, str)
+   3.11. is_myself(uri)
+   3.12. setdebug(level)
+   3.13. resetdebug()
+   3.14. km_append_branch([uri])
3.1. setsflag(flag)
@@ -248,12 +248,12 @@ if(isbflagset("1"))
 }
 ...
-3.6. resetsflag(flag [, branch])
+3.6. resetbflag(flag [, branch])
-   Reset the script flag.
+   Reset the branch flag.
Meaning of the parameters is as follows:
-     * flag - the index of the script flag to be reset. Can be integer or
+     * flag - the index of the branch flag to be reset. Can be integer or
        pseudo-variable with integer value.
      * branch - the index of the branch whose flag to be set. Can be
        integer or pseudo-variable with integer value. If omitted, then
@@ -261,17 +261,12 @@ if(isbflagset("1"))
This function can be used from ANY_ROUTE.
-   Example 1.6. resetsflag usage
+   Example 1.6. resetbflag usage
 ...
 resetbflag("1");
 ...
-3.7. km_append_branch([uri])
-
-   It was replaced by append_branch() from corex module, starting with
-   version 3.4.0.
-
-3.8. setdsturi(uri)
+3.7. setdsturi(uri)
Set the destination address URI (outbound proxy address).
@@ -288,7 +283,7 @@ resetbflag("1");
 setdsturi("sip:10.0.0.10");
 ...
-3.9. resetdsturi()
+3.8. resetdsturi()
Reset the destination address URI (outbound proxy address).
@@ -299,7 +294,7 @@ setdsturi("sip:10.0.0.10");
 resetdsturi();
 ...
-3.10. isdsturiset()
+3.9. isdsturiset()
Check if the destination address URI (outbound proxy address) is set.
@@ -313,10 +308,10 @@ if(isdsturiset())
 }
 ...
-3.11. pv_printf(var, str)
+3.10. pv_printf(var, str)
-   Evalues the str and sets the resulted value to variable var. For
-   backward compatibility reasons, same function can be executed via
+   Evalues the str and sets the resulting value to variable var. For
+   backward compatibility reasons, the same function can be executed via
    'avp_printf(var, str)'.
Meaning of the parameters is as follows:
@@ -332,7 +327,7 @@ pv_printf("$ru", "sip:$rU@$fd");
 pv_printf("$avp(x)", "From: $fU - To: $tU");
 ...
-3.12. is_myself(uri)
+3.11. is_myself(uri)
Check if the parameter matches the 'myself' condition (i.e., is a local
    IP or domain).
@@ -351,7 +346,7 @@ if(is_myself("$fu")) {
 }
 ...
-3.13. setdebug(level)
+3.12. setdebug(level)
Set the debug log level per process.
@@ -369,7 +364,7 @@ $var(level) = 2;
 setdebug("$var(level)");
 ...
-3.14. resetdebug()
+3.13. resetdebug()
Reset the local debug log level back to the value of core parameter
    'debug'.
@@ -381,6 +376,11 @@ setdebug("$var(level)");
 resetdebug();
 ...
+3.14. km_append_branch([uri])
+
+   This function was replaced by append_branch() from corex module,
+   starting with version 4.0.0.
+
 4. MI Commands
4.1. arg
diff --git a/modules/kex/doc/kex_admin.xml b/modules/kex/doc/kex_admin.xml
index 3caa58d..f3f020d 100644
--- a/modules/kex/doc/kex_admin.xml
+++ b/modules/kex/doc/kex_admin.xml
@@ -215,15 +215,15 @@ if(isbflagset("1"))
    	</example>
    	</section>
    	<section>
-		<title><function moreinfo="none">resetsflag(flag [, branch])</function></title>
+		<title><function moreinfo="none">resetbflag(flag [, branch])</function></title>
    	<para>
-			Reset the script flag.
+			Reset the branch flag.
    	</para>
    	<para>Meaning of the parameters is as follows:</para>
    	<itemizedlist>
    	<listitem>
    		<para>
-				<emphasis>flag</emphasis> - the index of the script flag to
+				<emphasis>flag</emphasis> - the index of the branch flag to
    			be reset. Can be integer or pseudo-variable with integer value.
    		</para>
    	</listitem>
@@ -239,7 +239,7 @@ if(isbflagset("1"))
    	This function can be used from ANY_ROUTE.
    	</para>
    	<example>
-		<title><function>resetsflag</function> usage</title>
+		<title><function>resetbflag</function> usage</title>
    	<programlisting format="linespecific">
 ...
 resetbflag("1");
@@ -248,13 +248,6 @@ resetbflag("1");
    	</example>
    	</section>
    	<section>
-		<title><function moreinfo="none">km_append_branch([uri])</function></title>
-		<para>
-			It was replaced by append_branch() from corex module, starting with
-			version 3.4.0.
-		</para>
-		</section>
-		<section>
    	<title><function moreinfo="none">setdsturi(uri)</function></title>
    	<para>
    		Set the destination address URI (outbound proxy address).
@@ -266,7 +259,8 @@ resetbflag("1");
    			<emphasis>uri</emphasis> - Valid SIP URI representing the
    			address where to send the request. It must be a static string,
    			no variables are evaluated at runtime. If you need to set
-				outbound proxy address via a variable, use assginment to $du.
+				outbound proxy address via a variable, use assginment to
+				<emphasis>$du</emphasis>.
    		</para>
    	</listitem>
    	</itemizedlist>
@@ -323,8 +317,8 @@ if(isdsturiset())
    	<section>
    	<title><function moreinfo="none">pv_printf(var, str)</function></title>
    	<para>
-			Evalues the str and sets the resulted value to variable var. For
-			backward compatibility reasons, same function can be executed via
+			Evalues the str and sets the resulting value to variable var. For
+			backward compatibility reasons, the same function can be executed via
    		'avp_printf(var, str)'.
    	</para>
    	<para>Meaning of the parameters is as follows:</para>
@@ -431,6 +425,13 @@ resetdebug();
 </programlisting>
    	</example>
    	</section>
+		<section>
+		<title><function moreinfo="none">km_append_branch([uri])</function></title>
+		<para>
+			This function was replaced by append_branch() from corex module, starting with
+			version 4.0.0.
+		</para>
+		</section>
    </section>
<section>

    