[sr-dev] git:master: all: fixed matrix doc generation and updates for &defaultdb;

Module: sip-router Branch: master Commit: 0d9eec94cea33aeeb7dee79664bab512194316b1 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0d9eec9… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Thu Oct 18 14:46:37 2012 +0200 all: fixed matrix doc generation and updates for &defaultdb; --- modules/dialplan/doc/dialplan_admin.xml | 2 +- modules/matrix/README | 72 ++++++++++++++++++++++- modules/matrix/doc/matrix_db.xml | 10 +++ modules_k/drouting/doc/drouting_admin.xml | 2 +- modules_k/htable/doc/htable_admin.xml | 2 +- modules_k/msilo/doc/msilo_admin.xml | 2 +- modules_k/uac/doc/uac_admin.xml | 2 +- modules_k/xcap_server/doc/xcap_server_admin.xml | 4 +- 8 files changed, 88 insertions(+), 8 deletions(-) diff --git a/modules/dialplan/doc/dialplan_admin.xml b/modules/dialplan/doc/dialplan_admin.xml index 254e124..8a54073 100644 --- a/modules/dialplan/doc/dialplan_admin.xml +++ b/modules/dialplan/doc/dialplan_admin.xml @@ -113,7 +113,7 @@ <para> <emphasis> Default value is - <quote>mysql://openser:openserrw@localhost/openser</quote>. + <quote>&defaultdb;</quote>. </emphasis> </para> <example> diff --git a/modules/matrix/README b/modules/matrix/README index e001780..935ab9f 100644 --- a/modules/matrix/README +++ b/modules/matrix/README @@ -44,6 +44,14 @@ Henning Westerholt 6.1. Database setup + 2. Module parameter for database access. + + 1. db_url (String) + 2. matrix_table (String) + 3. matrix_first_col (string) + 4. matrix_second_col (string) + 5. matrix_res_col (string) + List of Examples 1.1. Set db_url parameter @@ -54,6 +62,11 @@ Henning Westerholt 1.6. matrix usage 1.7. reload_matrix usage 1.8. Example database content - matrix table + 2.1. Set db_url parameter + 2.2. Set matrix_table parameter + 2.3. Set matrix_first_col parameter + 2.4. Set matrix_second_col parameter + 2.5. Set matrix_res_col parameter Chapter 1. Admin Guide @@ -237,4 +250,61 @@ kamctl fifo reload_matrix +---------+--------------+---------+ ... - <xi:include></xi:include> +Chapter 2. Module parameter for database access. + + Table of Contents + + 1. db_url (String) + 2. matrix_table (String) + 3. matrix_first_col (string) + 4. matrix_second_col (string) + 5. matrix_res_col (string) + +1. db_url (String) + + URL to the database containing the data. + + Default value is "mysql://openserro:openserro@localhost/openser". + + Example 2.1. Set db_url parameter +... +modparam("matrix", "db_url", "dbdriver://username:password@dbhost/dbname") +... + +2. matrix_table (String) + + Name of the matrix table for the matrix module. + + Default value is "matrix". + + Example 2.2. Set matrix_table parameter +... +modparam("matrix", "matrix_table", "matrix") +... + +3. matrix_first_col (string) + + The row index in the matrix + + Example 2.3. Set matrix_first_col parameter +... +modparam("matrix", "matrix_first_col", "first") +... + +4. matrix_second_col (string) + + The column index in the matrix + + Example 2.4. Set matrix_second_col parameter +... +modparam("matrix", "matrix_second_col", "second") +... + +5. matrix_res_col (string) + + The resource contained in the matrix + + Example 2.5. Set matrix_res_col parameter +... +modparam("matrix", "matrix_res_col", "res") +... diff --git a/modules/matrix/doc/matrix_db.xml b/modules/matrix/doc/matrix_db.xml index 3ce4f06..5c603a0 100644 --- a/modules/matrix/doc/matrix_db.xml +++ b/modules/matrix/doc/matrix_db.xml @@ -1,3 +1,13 @@ +<?xml version="1.0" encoding='ISO-8859-1'?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml"> +%docentities; + +]> + <!-- WARNING: This file was autogenerated from the XML source file diff --git a/modules_k/drouting/doc/drouting_admin.xml b/modules_k/drouting/doc/drouting_admin.xml index 00bd617..933a8cf 100644 --- a/modules_k/drouting/doc/drouting_admin.xml +++ b/modules_k/drouting/doc/drouting_admin.xml @@ -834,7 +834,7 @@ <programlisting format="linespecific"> ... modparam("drouting", "db_url", - "mysql://openser:openserrw@localhost/openser") + "&defaultdb;") ... </programlisting> </example> diff --git a/modules_k/htable/doc/htable_admin.xml b/modules_k/htable/doc/htable_admin.xml index 9749c9b..32f51ce 100644 --- a/modules_k/htable/doc/htable_admin.xml +++ b/modules_k/htable/doc/htable_admin.xml @@ -304,7 +304,7 @@ modparam("htable", "htable", "c=&gt;size=4;autoexpire=7200;initval=1;") <title>Set <varname>db_url</varname> parameter</title> <programlisting format="linespecific"> ... -modparam("htable", "db_url", "mysql://openser:openserrw@localhost/openser") +modparam("htable", "db_url", "&defaultdb;") ... </programlisting> </example> diff --git a/modules_k/msilo/doc/msilo_admin.xml b/modules_k/msilo/doc/msilo_admin.xml index 22de746..3f08420 100644 --- a/modules_k/msilo/doc/msilo_admin.xml +++ b/modules_k/msilo/doc/msilo_admin.xml @@ -101,7 +101,7 @@ <para> <emphasis> Default value is - <quote>mysql://openser:openserrw@localhost/openser</quote>. + <quote>&defaultdb;</quote>. </emphasis> </para> <example> diff --git a/modules_k/uac/doc/uac_admin.xml b/modules_k/uac/doc/uac_admin.xml index eed2def..53a1fa1 100644 --- a/modules_k/uac/doc/uac_admin.xml +++ b/modules_k/uac/doc/uac_admin.xml @@ -368,7 +368,7 @@ modparam("uac","auth_password_avp","$avp(i:12)") <programlisting format="linespecific"> ... modparam("uac", "reg_db_url", - "mysql://openser:openserrw@localhost/openser") + "&defaultdb;") ... </programlisting> </example> diff --git a/modules_k/xcap_server/doc/xcap_server_admin.xml b/modules_k/xcap_server/doc/xcap_server_admin.xml index 60decd4..b0b4e8b 100644 --- a/modules_k/xcap_server/doc/xcap_server_admin.xml +++ b/modules_k/xcap_server/doc/xcap_server_admin.xml @@ -121,7 +121,7 @@ <para> <emphasis> Default value is - <quote>mysql://openser:openserrw@localhost/openser</quote>. + <quote>&defaultdb;</quote>. </emphasis> </para> <example> @@ -339,7 +339,7 @@ loadmodule "xcap_server.so" # ----- xcap_server params ----- modparam("xcap_server", "db_url", - "mysql://openser:openserrw@localhost/openser") + "&defaultdb;") ...