[sr-dev] git:master: uri_db Documentation update, section IDs added
Olle E. Johansson
oej at edvina.net
Sun Oct 12 20:38:56 CEST 2014
Module: sip-router
Branch: master
Commit: 73e5bc5896cc30d63cd92919ebf3da2e3c72ee26
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=73e5bc5896cc30d63cd92919ebf3da2e3c72ee26
Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: Sun Oct 12 20:38:27 2014 +0200
uri_db Documentation update, section IDs added
---
modules/uri_db/README | 14 +++++++-------
modules/uri_db/doc/uri_db_admin.xml | 30 +++++++++++++++---------------
2 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/modules/uri_db/README b/modules/uri_db/README
index 1bf2cc2..2a7d42c 100644
--- a/modules/uri_db/README
+++ b/modules/uri_db/README
@@ -118,7 +118,7 @@ Chapter 1. Admin Guide
If the db_url string is empty, the default database URL will be used.
- Default value is "mysql://openserro:openserro@localhost/openser".
+ Default value is "mysql://kamailioro:kamailioro@localhost/kamailio".
Example 1.1. Set db_url parameter
...
@@ -129,7 +129,7 @@ modparam("uri_db", "db_url", "mysql://username:password@localhost/openser")
The DB table that should be used. Its possible to use the "subscriber"
and "uri" table. If the "uri" table should be used, an additional
- parameter (Section 3.6, "use_uri_table (integer)") must be set.
+ parameter "use-uri-table") must be set.
Default value is "subscriber".
@@ -208,8 +208,8 @@ modparam("uri_db", "use_domain", 1)
4.1. check_to()
- Check To username against URI table (if use_uri_table is set) or digest
- credentials (no DB backend required).
+ Check "To" username against URI table (if use_uri_table is set) or
+ digest credentials (no DB backend required).
This function can be used from REQUEST_ROUTE.
@@ -222,7 +222,7 @@ if (check_to()) {
4.2. check_from()
- Check From username against URI table (if use_uri_table is set) or
+ Check "From" username against URI table (if use_uri_table is set) or
digest credentials (no DB backend required).
This function can be used from REQUEST_ROUTE.
@@ -238,8 +238,8 @@ if (check_from()) {
Check if username in the request URI belongs to an existing user.
- As the checking is done against URI table (if use_uri_table is set) or
- subscriber table.
+ The checking is done against the URI table (if use_uri_table is set) or
+ the subscriber table.
This function can be used from REQUEST_ROUTE.
diff --git a/modules/uri_db/doc/uri_db_admin.xml b/modules/uri_db/doc/uri_db_admin.xml
index 89f5bf6..2dc0e43 100644
--- a/modules/uri_db/doc/uri_db_admin.xml
+++ b/modules/uri_db/doc/uri_db_admin.xml
@@ -50,7 +50,7 @@
<section>
<title>Parameters</title>
- <section>
+ <section id="uri_db.p.db_url">
<title><varname>db_url</varname> (string)</title>
<para>
&url; of the database to be used.
@@ -74,13 +74,13 @@ modparam("uri_db", "db_url", "mysql://username:password@localhost/openser")
</example>
</section>
- <section>
+ <section id="uri_db.p.db_table">
<title><varname>db_table</varname> (string)</title>
<para>
The DB table that should be used. Its possible to use the
<quote>subscriber</quote> and <quote>uri</quote> table. If the
<quote>uri</quote> table should be used, an additional parameter
- (<xref linkend="use-uri-table"/>) must be set.
+ <quote>use-uri-table</quote>) must be set.
</para>
<para>
<emphasis>
@@ -97,7 +97,7 @@ modparam("uri_db", "db_table", "uri")
</example>
</section>
- <section>
+ <section id="uri_db.p.user_column">
<title><varname>user_column</varname> (string)</title>
<para>
Column holding usernames in the table.
@@ -117,7 +117,7 @@ modparam("uri_db", "user_column", "username")
</example>
</section>
- <section>
+ <section id="uri_db.p.domain_column">
<title><varname>domain_column</varname> (string)</title>
<para>
Column holding domain in the table.
@@ -137,7 +137,7 @@ modparam("uri_db", "domain_column", "domain")
</example>
</section>
- <section>
+ <section id="uri_db.p.uriuser_column">
<title><varname>uriuser_column</varname> (string)</title>
<para>
Column holding &uri; username in the table.
@@ -157,7 +157,7 @@ modparam("uri_db", "uriuser_column", "uri_user")
</example>
</section>
- <section id="use-uri-table">
+ <section id="uri_db.p.use_uri_table">
<title><varname>use_uri_table</varname> (integer)</title>
<para>
Specify if the <quote>uri</quote> table should be used for checkings
@@ -178,7 +178,7 @@ modparam("uri_db", "use_uri_table", 1)
</example>
</section>
- <section>
+ <section id="uri_db.p.use_domain">
<title><varname>use_domain</varname> (integer)</title>
<para>
Specify if the domain part of the URI should be used to identify the
@@ -207,12 +207,12 @@ modparam("uri_db", "use_domain", 1)
</section>
<section>
<title>Functions</title>
- <section>
+ <section id="uri_db.f.check_to">
<title>
<function moreinfo="none">check_to()</function>
</title>
<para>
- Check To username against &uri; table (if use_uri_table is set) or
+ Check <quote>To</quote> username against &uri; table (if use_uri_table is set) or
digest credentials (no DB backend required).
</para>
<para>
@@ -230,12 +230,12 @@ if (check_to()) {
</example>
</section>
- <section>
+ <section id="uri_db.f.check_from">
<title>
<function moreinfo="none">check_from()</function>
</title>
<para>
- Check From username against &uri; table (if use_uri_table is set) or
+ Check <quote>From</quote> username against &uri; table (if use_uri_table is set) or
digest credentials (no DB backend required).
</para>
<para>
@@ -253,7 +253,7 @@ if (check_from()) {
</example>
</section>
- <section>
+ <section id="uri_db.f.does_uri_exist">
<title>
<function moreinfo="none">does_uri_exist()</function>
</title>
@@ -261,8 +261,8 @@ if (check_from()) {
Check if username in the request &uri; belongs to an existing user.
</para>
<para>
- As the checking is done against &uri; table (if use_uri_table is set)
- or subscriber table.
+ The checking is done against the &uri; table (if use_uri_table is set)
+ or the subscriber table.
</para>
<para>
This function can be used from REQUEST_ROUTE.
More information about the sr-dev
mailing list