[sr-dev] git:master: Updating SER to SIP-router, spelling fixes

Module: sip-router Branch: master Commit: 54d552f42a188f231df33402612215f6f8bd703f URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=54d552f… Author: oej &lt;oej(a)edvina.net&gt; Committer: oej &lt;oej(a)edvina.net&gt; Date: Thu Oct 22 22:15:28 2009 +0200 Updating SER to SIP-router, spelling fixes --- modules_s/sanity/README | 29 +++++++++++++++-------------- modules_s/sanity/doc/functions.xml | 10 ++++++++-- modules_s/sanity/doc/params.xml | 16 +++++++++++----- modules_s/sanity/doc/sanity.xml | 10 +++++----- 4 files changed, 39 insertions(+), 26 deletions(-) diff --git a/modules_s/sanity/README b/modules_s/sanity/README index 3bab7b4..0e364e3 100644 --- a/modules_s/sanity/README +++ b/modules_s/sanity/README @@ -25,20 +25,21 @@ Nils Ohlmeier This module aims to implement several sanity checks on incoming requests which are suggested or even required by a RFC, but are not - available yet in the core of SER. + available yet in the core of SIP-router. - This checks are not required by SER 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 SER - adminstrator which checks should be done on which request. + This 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. The following checks are available: * ruri sip version - (1) - checks if the SIP version in the request URI is supported, currently only 2.0. * ruri scheme - (2) - checks if the URI scheme of the request URI is - supported (sip[s]|tel[s]) by SER. + supported (sip[s]|tel[s]) by SIP-router. * required headers - (4) -checks if the minimum set of required headers to, from, cseq, callid and via is present in the request. * via sip version - (8) - not working because parser fails already @@ -57,7 +58,7 @@ Nils Ohlmeier header are present in the list of the extensions from the module parameter proxy_require. * parse uri's - (1024) - checks if the specified URIs are present and - parseable by the SER parsers + parseable by the SIP-router parsers * digest credentials (2048) Check all instances of digest credentials in a message. The test checks whether there are all required digest parameters and have meaningful values. @@ -100,10 +101,10 @@ modparam("sanity", "default_checks", "1") 1.3.3. proxy_require (string) - This parameter set the list of supported extensions for this SER. The - value is expected as comma seperated list of the extensions. This list - is seperated into single tokens. Each token from a proxy require header - will be compare to the tokens from this list. + This parameter set the list of supported extensions for this + SIP-router. The value is expected as comma separated list of the + extensions. This list is separated into single tokens. Each token from + a proxy require header will be compare to the tokens from this list. Example 2. Set proxy_require parameter ... @@ -115,7 +116,7 @@ modparam("sanity", "proxy_require", "foo, bar") Revision History Revision $Revision$ $Date$ -1.4.1. sanity_check() +1.4.1. sanity_check() This function makes a row of sanity checks on the given request. The function returns true if one of the checks failed. If one of the checks diff --git a/modules_s/sanity/doc/functions.xml b/modules_s/sanity/doc/functions.xml index 1d60930..85f788d 100644 --- a/modules_s/sanity/doc/functions.xml +++ b/modules_s/sanity/doc/functions.xml @@ -1,6 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> <section id="options.functions" xmlns:xi="http://www.w3.org/2001/XInclude"> <sectioninfo> diff --git a/modules_s/sanity/doc/params.xml b/modules_s/sanity/doc/params.xml index 82b31df..b56affd 100644 --- a/modules_s/sanity/doc/params.xml +++ b/modules_s/sanity/doc/params.xml @@ -1,6 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> <section id="sanity.parameters" xmlns:xi="http://www.w3.org/2001/XInclude"> <sectioninfo> @@ -54,9 +60,9 @@ modparam("sanity", "default_checks", "1") <section id="proxy_require"> <title><varname>proxy_require</varname> (string)</title> <para> - This parameter set the list of supported extensions for this SER. - The value is expected as comma seperated list of the extensions. - This list is seperated into single tokens. Each token from + This parameter set the list of supported extensions for this SIP-router. + The value is expected as comma separated list of the extensions. + This list is separated into single tokens. Each token from a proxy require header will be compare to the tokens from this list. </para> diff --git a/modules_s/sanity/doc/sanity.xml b/modules_s/sanity/doc/sanity.xml index c808cf5..9e3accc 100644 --- a/modules_s/sanity/doc/sanity.xml +++ b/modules_s/sanity/doc/sanity.xml @@ -33,15 +33,15 @@ <para> This module aims to implement several sanity checks on incoming requests which are suggested or even required by a RFC, but are - not available yet in the core of SER. + not available yet in the core of SIP-router. </para> <para> - This checks are not required by SER itself for its functionality. + This 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 SER adminstrator which checks + is now with this module up to the SIP-router adminstrator which checks should be done on which request. </para> <para> @@ -56,7 +56,7 @@ <listitem> <para> ruri scheme - (2) - checks if the URI scheme of the request URI is - supported (sip[s]|tel[s]) by SER. + supported (sip[s]|tel[s]) by SIP-router. </para> </listitem> <listitem> @@ -111,7 +111,7 @@ <listitem> <para> parse uri's - (1024) - checks if the specified URIs are present and - parseable by the SER parsers + parseable by the SIP-router parsers </para> </listitem> <listitem>