[sr-dev] git:master: Some minor tweaks to documentation for textopsx.

Alex Balashov abalashov at evaristesys.com
Wed Oct 6 09:04:46 CEST 2010


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

Author: Alex Balashov <abalashov at evaristesys.com>
Committer: Alex Balashov <abalashov at evaristesys.com>
Date:   Wed Oct  6 03:04:09 2010 -0400

Some minor tweaks to documentation for textopsx.

---

 modules/textopsx/README            |   13 ++++++-------
 modules/textopsx/doc/functions.xml |   12 ++++++------
 2 files changed, 12 insertions(+), 13 deletions(-)

diff --git a/modules/textopsx/README b/modules/textopsx/README
index cece6b5..73d894b 100644
--- a/modules/textopsx/README
+++ b/modules/textopsx/README
@@ -28,11 +28,10 @@ Daniel-Constantin Mierla
 
 1.2.1.  msg_apply_changes()
 
-   Use this function to apply changes done on SIP request content. Be
-   careful when using this function -- due to special handling of changes
-   done to SIM message buffer so far, using this function might change the
-   behaviour of your config as it was so far -- do test properly your
-   config!
+   Use this function to apply changes performed on SIP request content. Be
+   careful when using this function; due to special handling of changes
+   done to SIP message buffer so far, using this function might change the
+   behaviour of your config. Do test your config properly!
 
    This function can be used from REQUEST_ROUTE.
 
@@ -51,8 +50,8 @@ if(msg_apply_changes())
 
 1.2.2.  change_reply_status(code, reason)
 
-   Change the status code and reason phrase of a SIP reply in
-   onreply_route.
+   Intercept a SIP reply (in an onreply_route) and change its status code
+   and reason phrase prior to propogating it.
 
    Meaning of the parameters is as follows:
      * code - Status code.
diff --git a/modules/textopsx/doc/functions.xml b/modules/textopsx/doc/functions.xml
index bc0fc38..9d7d4f6 100644
--- a/modules/textopsx/doc/functions.xml
+++ b/modules/textopsx/doc/functions.xml
@@ -10,11 +10,10 @@
 		<function moreinfo="none">msg_apply_changes()</function>
 		</title>
 		<para>
-		Use this function to apply changes done on SIP request content. Be
-		careful when using this function -- due to special handling of changes
-		done to SIM message buffer so far, using this function might change
-		the behaviour of your config as it was so far -- do test properly
-		your config!
+		Use this function to apply changes performed on SIP request content. Be
+		careful when using this function;  due to special handling of changes
+		done to SIP message buffer so far, using this function might change
+		the behaviour of your config.  Do test your config properly!
 		</para>
    		<para>
 		This function can be used from REQUEST_ROUTE.
@@ -42,7 +41,8 @@ if(msg_apply_changes())
 	    <function>change_reply_status(code, reason)</function>
 	</title>
 	<para>
-		Change the status code and reason phrase of a SIP reply in onreply_route.
+		Intercept a SIP reply (in an onreply_route) and change its status code 
+		and reason phrase prior to propogating it.
 	</para>
 	<para>Meaning of the parameters is as follows:</para>
 	<itemizedlist>




More information about the sr-dev mailing list