[sr-dev] git:4.3:9e05772c: mtree: more details about what module does and max prefix size

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 4.3
Commit: 9e05772c277f487d0c5bacdb33b1aaa8634e133f
URL: https://github.com/kamailio/kamailio/commit/9e05772c277f487d0c5bacdb33b1aaa8634e133f

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2015-06-09T10:33:28+02:00

mtree: more details about what module does and max prefix size

(cherry picked from commit 74fadc549929d3dc873ce3b8b1db20559562ab54)

---

Modified: modules/mtree/doc/mtree_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/9e05772c277f487d0c5bacdb33b1aaa8634e133f.diff
Patch: https://github.com/kamailio/kamailio/commit/9e05772c277f487d0c5bacdb33b1aaa8634e133f.patch

---

diff --git a/modules/mtree/doc/mtree_admin.xml b/modules/mtree/doc/mtree_admin.xml
index 17c2c8f..8ca17e0 100644
--- a/modules/mtree/doc/mtree_admin.xml
+++ b/modules/mtree/doc/mtree_admin.xml
@@ -17,8 +17,18 @@
     <section>
 	<title>Overview</title>
 	<para>
-		This module loads data indexed by prefixes from database and returns
-		associated string or precompiled value.
+		This module loads (prefix, value) records from database and indexes
+		them in a named memory tree. Name of the tree is specified for each
+		record or as module parameter.
+	</para>
+	<para>	
+		It exports to configuration file functions to match against in-memory
+		trees and return the values (raw or precompiled) associated with
+		matched prefixes.
+	</para>
+	<para>	
+		The maximum size of the prefix is limited internally to 63, database
+		table definition may enforce lower maximum size.
 	</para>
     </section>
     <section>