[sr-dev] git:master: prefix_route doc file name changes

Module: sip-router Branch: master Commit: cbdadf3bff04e7837698ad84466fea2aed39b9c9 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=cbdadf3… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Thu Dec 20 20:48:19 2012 +0100 prefix_route doc file name changes --- modules/prefix_route/README | 55 ++++++++++---------- modules/prefix_route/doc/prefix_route.xml | 19 +++---- .../doc/{extra.xml => prefix_route_extra.xml} | 0 .../{functions.xml => prefix_route_functions.xml} | 0 .../doc/{params.xml => prefix_route_params.xml} | 0 .../doc/{rpc.xml => prefix_route_rpc.xml} | 0 6 files changed, 36 insertions(+), 38 deletions(-) diff --git a/modules/prefix_route/README b/modules/prefix_route/README index 0aa4780..648db7c 100644 --- a/modules/prefix_route/README +++ b/modules/prefix_route/README @@ -1,4 +1,4 @@ -1. prefix_route Module +prefix_route Module Alfred E. Heggestad @@ -9,25 +9,15 @@ Alfred E. Heggestad Copyright � 2008 Telio Telecom AS __________________________________________________________________ - 1.1. Overview - 1.2. Parameters + List of Examples - 1.2.1. db_url (string) - 1.2.2. db_table (string) - 1.2.3. exit (int) + 1. Setting db_url parameter + 2. Setting db_table parameter + 3. Setting exit parameter + 4. prefix_route() usage + 5. Sample data - 1.3. Functions - - 1.3.1. prefix_route([user]) - - 1.4. RPC Commands - - 1.4.1. prefix_route.reload - 1.4.2. prefix_route.dump - - 1.5. Database Structure - -1.1. Overview +1. Overview The prefix_route module does routing based on a set of prefixes from the database. The prefix rule-set is loaded from the database into a @@ -40,9 +30,13 @@ Alfred E. Heggestad Development was sponsored by Telio Telecom. -1.2. Parameters +2. Parameters + + 2.1. db_url (string) + 2.2. db_table (string) + 2.3. exit (int) -1.2.1. db_url (string) +2.1. db_url (string) This is URL of the database to be used. @@ -53,7 +47,7 @@ Alfred E. Heggestad modparam("prefix_route", "db_url", "mysql://ser:pass@db_host/ser") ... -1.2.2. db_table (string) +2.2. db_table (string) The name of table where to read prefix route set. @@ -64,7 +58,7 @@ modparam("prefix_route", "db_url", "mysql://ser:pass@db_host/ser") modparam("prefix_route", "db_table", "new_prefix_route") ... -1.2.3. exit (int) +2.3. exit (int) If set, exit the execution of the configuration file when a route block is executed upon matching a prefix. Otherwise return 1 (true). @@ -76,9 +70,11 @@ modparam("prefix_route", "db_table", "new_prefix_route") modparam("prefix_route", "exit", 0) ... -1.3. Functions +3. Functions -1.3.1. prefix_route([user]) + 3.1. prefix_route([user]) + +3.1. prefix_route([user]) This function tries to find a route from the user part of the request URI (if no parameter is provided), or from the value of the parameter. @@ -99,18 +95,21 @@ modparam("prefix_route", "exit", 0) ... -1.4. RPC Commands +4. RPC Commands + + 4.1. prefix_route.reload + 4.2. prefix_route.dump -1.4.1. prefix_route.reload +4.1. prefix_route.reload Reload prefix route tree from the database. Validation is done and the prefix route tree will only be reloaded if there are no errors. -1.4.2. prefix_route.dump +4.2. prefix_route.dump Dump the current prefix route tree. -1.5. Database Structure +5. Database Structure A prefix route set consists of three fields: * prefix - varchar(64) - Prefix rule diff --git a/modules/prefix_route/doc/prefix_route.xml b/modules/prefix_route/doc/prefix_route.xml index 1244849..5ebdd43 100644 --- a/modules/prefix_route/doc/prefix_route.xml +++ b/modules/prefix_route/doc/prefix_route.xml @@ -2,8 +2,9 @@ <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<section id="blst" xmlns:xi="http://www.w3.org/2001/XInclude"> - <sectioninfo> +<book id="blst" xmlns:xi="http://www.w3.org/2001/XInclude"> + <bookinfo> + <title>prefix_route Module</title> <authorgroup> <author> <firstname>Alfred E.</firstname> @@ -19,9 +20,7 @@ <year>2008</year> <holder>Telio Telecom AS</holder> </copyright> - </sectioninfo> - - <title>prefix_route Module</title> + </bookinfo> <section id="prefixroute.overview"> <title>Overview</title> @@ -39,10 +38,10 @@ </para> </section> - <xi:include href="params.xml"/> - <xi:include href="functions.xml"/> - <xi:include href="rpc.xml"/> - <xi:include href="extra.xml"/> + <xi:include href="prefix_route_params.xml"/> + <xi:include href="prefix_route_functions.xml"/> + <xi:include href="prefix_route_rpc.xml"/> + <xi:include href="prefix_route_extra.xml"/> -</section> +</book> diff --git a/modules/prefix_route/doc/extra.xml b/modules/prefix_route/doc/prefix_route_extra.xml similarity index 100% rename from modules/prefix_route/doc/extra.xml rename to modules/prefix_route/doc/prefix_route_extra.xml diff --git a/modules/prefix_route/doc/functions.xml b/modules/prefix_route/doc/prefix_route_functions.xml similarity index 100% rename from modules/prefix_route/doc/functions.xml rename to modules/prefix_route/doc/prefix_route_functions.xml diff --git a/modules/prefix_route/doc/params.xml b/modules/prefix_route/doc/prefix_route_params.xml similarity index 100% rename from modules/prefix_route/doc/params.xml rename to modules/prefix_route/doc/prefix_route_params.xml diff --git a/modules/prefix_route/doc/rpc.xml b/modules/prefix_route/doc/prefix_route_rpc.xml similarity index 100% rename from modules/prefix_route/doc/rpc.xml rename to modules/prefix_route/doc/prefix_route_rpc.xml