Skip to content

Commit

Permalink
mtree: more details about what module does and max prefix size
Browse files Browse the repository at this point in the history
(cherry picked from commit 74fadc5)
  • Loading branch information
miconda committed Jun 9, 2015
1 parent bfe40dd commit 9e05772
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions modules/mtree/doc/mtree_admin.xml
Expand Up @@ -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>
Expand Down

0 comments on commit 9e05772

Please sign in to comment.