فهرست منبع

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

(cherry picked from commit 74fadc549929d3dc873ce3b8b1db20559562ab54)
Daniel-Constantin Mierla 10 سال پیش
والد
کامیت
9e05772c27
1فایلهای تغییر یافته به همراه12 افزوده شده و 2 حذف شده
  1. 12 2
      modules/mtree/doc/mtree_admin.xml

+ 12 - 2
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>