Module: sip-router Branch: master Commit: d43fbf2a5a5464a4a499282b88d58a1fc97b9c7e URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=d43fbf2… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Sun Nov 25 16:38:27 2012 +0100 sanity Sanity-checked spelling. Minor corrections. --- modules/sanity/README | 26 +++++++++++++------------- modules/sanity/doc/functions.xml | 4 ++-- modules/sanity/doc/params.xml | 6 +++--- modules/sanity/doc/sanity.xml | 6 +++--- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/modules/sanity/README b/modules/sanity/README index 27bcaa1..6956733 100644 --- a/modules/sanity/README +++ b/modules/sanity/README @@ -26,13 +26,13 @@ Nils Ohlmeier requests which are suggested or even required by a RFC, but are not available yet in the core of SIP-router. - This checks are not required by SIP-router itself for its + These checks are not required by SIP-router itself for its functionality. But on the other side it makes not much sence if a broken request traverses through a SIP network if it is rejected sooner - or later by a SIP device any way. As every sanity cost extra - performance because of additional parsing and evaluation it is now with - this module up to the SIP-router adminstrator which checks should be - done on which request. + or later by a SIP device any way. As every sanity check cost extra + performance because of additional parsing and evaluation it is with + this module now up to the SIP-router adminstrator which checks should + be done on which request. The following checks are available: * ruri sip version - (1) - checks if the SIP version in the request @@ -102,10 +102,10 @@ modparam("sanity", "uri_checks", 3) 1.3.3. proxy_require (string) - This parameter set the list of supported extensions for this - SIP-router. The value is expected as comma separated list of the + This parameter sets the list of supported extensions for this + SIP-router. The value is expected as a comma separated list of extensions. This list is separated into single tokens. Each token from - a proxy require header will be compare to the tokens from this list. + a proxy require header will be compared to the tokens from this list. Example 3. Set proxy_require parameter ... @@ -128,13 +128,13 @@ modparam("sanity", "autodrop", 1) 1.4. Functions -1.4.1. sanity_check([msg_checks [, uri_checks]]) +1.4.1. sanity_check([msg_checks [, uri_checks]]) This function makes a row of sanity checks over the given SIP request. - The behavior of the function is also controled by 'autodrop' parameter. - If autodrop=0, the function returns false (-1) if one of the checks - failed. When autodrop=1, the function stops the execution of - configuration file. In both cases, ff one of the checks fails the + The behavior of the function is also controlled by 'autodrop' + parameter. If autodrop=0, the function returns false (-1) if one of the + checks failed. When autodrop=1, the function stops the execution of + configuration file. In both cases, if one of the checks fails the module sends a precise error reply via SL send_reply(). Thus there is no need to reply with a generic error message. diff --git a/modules/sanity/doc/functions.xml b/modules/sanity/doc/functions.xml index 3a535c2..62d28e6 100644 --- a/modules/sanity/doc/functions.xml +++ b/modules/sanity/doc/functions.xml @@ -20,10 +20,10 @@ </title> <para> This function makes a row of sanity checks over the given SIP request. The - behavior of the function is also controled by 'autodrop' parameter. + behavior of the function is also controlled by 'autodrop' parameter. If autodrop=0, the function returns false (-1) if one of the checks failed. When autodrop=1, the function stops the execution of configuration file. - In both cases, ff one of the checks fails the module sends a precise error + In both cases, if one of the checks fails the module sends a precise error reply via SL send_reply(). Thus there is no need to reply with a generic error message. </para> diff --git a/modules/sanity/doc/params.xml b/modules/sanity/doc/params.xml index 552ec82..037b6f9 100644 --- a/modules/sanity/doc/params.xml +++ b/modules/sanity/doc/params.xml @@ -62,10 +62,10 @@ modparam("sanity", "uri_checks", 3) <section id="proxy_require"> <title><varname>proxy_require</varname> (string)</title> <para> - This parameter set the list of supported extensions for this SIP-router. - The value is expected as comma separated list of the extensions. + This parameter sets the list of supported extensions for this SIP-router. + The value is expected as a comma separated list of extensions. This list is separated into single tokens. Each token from - a proxy require header will be compare to the tokens from this + a proxy require header will be compared to the tokens from this list. </para> <example> diff --git a/modules/sanity/doc/sanity.xml b/modules/sanity/doc/sanity.xml index 1072a48..56127b5 100644 --- a/modules/sanity/doc/sanity.xml +++ b/modules/sanity/doc/sanity.xml @@ -30,12 +30,12 @@ not available yet in the core of SIP-router. </para> <para> - This checks are not required by SIP-router itself for its functionality. + These checks are not required by SIP-router itself for its functionality. But on the other side it makes not much sence if a broken request traverses through a SIP network if it is rejected sooner - or later by a SIP device any way. As every sanity cost extra + or later by a SIP device any way. As every sanity check cost extra performance because of additional parsing and evaluation it - is now with this module up to the SIP-router adminstrator which checks + is with this module now up to the SIP-router adminstrator which checks should be done on which request. </para> <para>