[sr-dev] git:master: textopsx - typo fixes, minor corrections

Module: sip-router Branch: master Commit: f9ab230357fcd551252a6bc151b278e792bcb54e URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=f9ab230… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Mon Oct 15 19:45:02 2012 +0200 textopsx - typo fixes, minor corrections --- modules/textopsx/README | 20 ++++++++++---------- modules/textopsx/doc/functions.xml | 12 ++++++------ modules/textopsx/doc/textopsx.xml | 6 +++--- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/modules/textopsx/README b/modules/textopsx/README index 104638a..e654e05 100644 --- a/modules/textopsx/README +++ b/modules/textopsx/README @@ -23,17 +23,17 @@ Daniel-Constantin Mierla 1.1. Overview - This is a module implementing funtions for text operations over SIP - messages in configuration files. It comes to add new features similar - to textops module (textops eXtentions). + This module implements functions for SIP message text operations in + routing block configurations. It adds new features similar to the + textops module (textops eXtentions). 1.2. Functions 1.2.1. msg_apply_changes() 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 + careful when using this function; due to special handling of changes to + the 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. @@ -54,7 +54,7 @@ if(msg_apply_changes()) 1.2.2. change_reply_status(code, reason) Intercept a SIP reply (in an onreply_route) and change its status code - and reason phrase prior to propogating it. + and reason phrase prior to forwarding it. Meaning of the parameters is as follows: * code - Status code. @@ -74,7 +74,7 @@ onreply_route { 1.2.3. remove_body() - Use this function to remove body of SIP requests or replies. + Use this function to remove the body of SIP requests or replies. This function can be used from ANY_ROUTE. @@ -99,11 +99,11 @@ keep_hf("User-Agent"); 1.2.5. fnmatch(value, expr [, flags]) - Match the value against the expr using the shell-style pattern for file + Match the value against the expr using shell-style pattern for file name matching (see man page for C function fnmatch()). It is known to - be faster and uses less-memory than regexp. + be faster and use less-memory than regular expressions. - Parameters flags is optional and can be 'i' to do case insensitive + Parameter 'flags' is optional and can be 'i' to do case insensitive matching. This function can be used from ANY_ROUTE. diff --git a/modules/textopsx/doc/functions.xml b/modules/textopsx/doc/functions.xml index ab4eb06..3fb5736 100644 --- a/modules/textopsx/doc/functions.xml +++ b/modules/textopsx/doc/functions.xml @@ -12,7 +12,7 @@ <para> 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 + to the SIP message buffer so far, using this function might change the behaviour of your config. Do test your config properly! </para> <para> @@ -42,7 +42,7 @@ if(msg_apply_changes()) </title> <para> Intercept a SIP reply (in an onreply_route) and change its status code - and reason phrase prior to propogating it. + and reason phrase prior to forwarding it. </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist> @@ -78,7 +78,7 @@ onreply_route { <function moreinfo="none">remove_body()</function> </title> <para> - Use this function to remove body of SIP requests or replies. + Use this function to remove the body of SIP requests or replies. </para> <para> This function can be used from ANY_ROUTE. @@ -122,12 +122,12 @@ keep_hf("User-Agent"); <function moreinfo="none">fnmatch(value, expr [, flags])</function> </title> <para> - Match the value against the expr using the shell-style pattern + Match the value against the expr using shell-style pattern for file name matching (see man page for C function fnmatch()). - It is known to be faster and uses less-memory than regexp. + It is known to be faster and use less-memory than regular expressions. </para> <para> - Parameters flags is optional and can be 'i' to do case insensitive + Parameter 'flags' is optional and can be 'i' to do case insensitive matching. </para> <para> diff --git a/modules/textopsx/doc/textopsx.xml b/modules/textopsx/doc/textopsx.xml index 25c4f26..a78811e 100644 --- a/modules/textopsx/doc/textopsx.xml +++ b/modules/textopsx/doc/textopsx.xml @@ -31,9 +31,9 @@ <section id="textops.overview"> <title>Overview</title> <para> - This is a module implementing funtions for text operations over - SIP messages in configuration files. It comes to add new features - similar to textops module (textops eXtentions). + This module implements functions for SIP message text operations + in routing block configurations. + It adds new features similar to the textops module (textops eXtentions). </para> </section>