[sr-dev] git:master: mtree Documentation fixes

[Olle E. Johansson]

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

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date:   Sun Oct 21 20:09:07 2012 +0200

mtree Documentation fixes

---

 modules/mtree/README              |   18 +++++++++---------
 modules/mtree/doc/mtree_admin.xml |   18 +++++++++++++-----
 2 files changed, 22 insertions(+), 14 deletions(-)

diff --git a/modules/mtree/README b/modules/mtree/README
index 8d76777..3be2e53 100644
--- a/modules/mtree/README
+++ b/modules/mtree/README
@@ -164,8 +164,8 @@ modparam("mtree", "db_url", "dbdriver://username:password@dbhost/dbname")
 
 3.2. db_table (string)
 
-   Name of DB table where data for trees is store. It is ignored if a
-   'mtree' parameter is defined.
+   Name of database table where data for trees is stored. It is ignored if
+   a 'mtree' parameter is defined.
 
    Default value is "mtrees".
 
@@ -242,7 +242,7 @@ modparam("mtree", "char_list", "0123456789*+")
 
 3.9. pv_value (string)
 
-   The PV spec where to store the matched value. It can be any writtable
+   The PV spec where to store the matched value. It can be any writable
    PV.
 
    Default value is "$avp(s:tvalue)".
@@ -305,12 +305,12 @@ modparam("mtree", "mt_allow_duplicates", 1)
 4.1. mt_match(mtree, pv, mode)
 
    Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value
-   of 'mode' is NOT 2, sets a value of longest matching prefix to pseudo
-   variable specified by pv_value parameter. If 'mtree' type is 0 or 2 and
-   value of 'mode' is 2, sets values of all matching prefixes to avp
-   specified by pv_values parameter so that a value of longest matching
-   prefix is in avp index 0. Parameter 'mode' can be an integer constant
-   or a pseudo variable with integer value.
+   of 'mode' is NOT 2, sets a value of the longest matching prefix to
+   pseudo variable specified by pv_value parameter. If 'mtree' type is 0
+   or 2 and value of 'mode' is 2, sets values of all matching prefixes to
+   avp specified by pv_values parameter so that a value of longest
+   matching prefix is in avp index 0. Parameter 'mode' can be an integer
+   constant or a pseudo variable with integer value.
 
    Example 1.14. mt_match usage
 ...
diff --git a/modules/mtree/doc/mtree_admin.xml b/modules/mtree/doc/mtree_admin.xml
index a58429c..8558ccd 100644
--- a/modules/mtree/doc/mtree_admin.xml
+++ b/modules/mtree/doc/mtree_admin.xml
@@ -76,7 +76,7 @@ modparam("mtree", "db_url", "&exampledb;")
 	<section>
 	    <title><varname>db_table</varname> (string)</title>
 	    <para>
-		Name of DB table where data for trees is store. It is ignored if a
+		Name of database table where data for trees is stored. It is ignored if a
 		'mtree' parameter is defined.
 	    </para>
 	    <para>
@@ -218,7 +218,7 @@ modparam("mtree", "char_list", "0123456789*+")
 	    <title><varname>pv_value</varname> (string)</title>
 	    <para>
 		The PV spec where to store the matched value. It can be any
-		writtable PV.
+		writable PV.
 		</para>
 	    <para>
 		<emphasis>
@@ -238,7 +238,8 @@ modparam("mtree", "pv_value", "$var(mtval)")
 	<section>
 	    <title><varname>pv_values</varname> (string)</title>
 	    <para>
-		The PV spec where to store the matched values when mtree is of type 0 or 2 and mode of mt_match() call has value 2. It can be any AVP.
+		The PV spec where to store the matched values when mtree is of type
+		0 or 2 and mode of mt_match() call has value 2. It can be any AVP.
 		</para>
 	    <para>
 		<emphasis>
@@ -258,7 +259,8 @@ modparam("mtree", "pv_values", "$avp(mtvals)")
 	<section>
 	    <title><varname>mt_tree_type</varname> (integer)</title>
 	    <para>
-		Default payload type for trees data stored in 'db_table'.  Documented values are 0 for string payloads and 2 for integer payloads.
+		Default payload type for trees data stored in 'db_table'. Documented
+		values are 0 for string payloads and 2 for integer payloads.
 	    </para>
 	    <para>
 		<emphasis>
@@ -324,7 +326,13 @@ modparam("mtree", "mt_allow_duplicates", 1)
 		<function moreinfo="none">mt_match(mtree, pv, mode)</function>
 	    </title>
 	    <para>
-		Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value of 'mode' is NOT 2, sets a value of longest matching prefix to pseudo variable specified by pv_value parameter. If 'mtree' type is 0 or 2 and value of 'mode' is 2, sets values of all matching prefixes to avp specified by pv_values parameter so that a value of longest matching prefix is in avp index 0.  Parameter 'mode' can be an integer constant or a pseudo variable with integer value.
+		Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value
+		of 'mode' is NOT 2, sets a value of the longest matching prefix to
+		pseudo variable specified by pv_value parameter. If 'mtree' type is 
+		0 or 2 and value of 'mode' is 2, sets values of all matching prefixes
+		to avp specified by pv_values parameter so that a value of longest
+		matching prefix is in avp index 0.  Parameter 'mode' can be an integer
+		constant or a pseudo variable with integer value.
 	    </para>
 		<example>
 		<title><function>mt_match</function> usage</title>