Skip to content

Commit

Permalink
p_usrloc: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Nov 13, 2023
1 parent 117d811 commit 7d2ad3f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 27 deletions.
6 changes: 3 additions & 3 deletions src/modules/p_usrloc/doc/p_usrloc.xml
Expand Up @@ -29,7 +29,7 @@
<email>patric.marschall.@1und1.de</email>
</address>
</editor>


<!--
<editor>
Expand All @@ -47,8 +47,8 @@
</copyright>
</bookinfo>
<toc></toc>

<xi:include href="p_usrloc_admin.xml"/>
<xi:include href="p_usrloc_devel.xml"/>

</book>
40 changes: 20 additions & 20 deletions src/modules/p_usrloc/doc/p_usrloc_admin.xml
Expand Up @@ -52,14 +52,14 @@
not available, the other database would be used. This failure is recorded in the
master database.
</para>

<para>Connections to the distributed databases are setup prior the actual query
is executed. The module maintains a cache of the database handles to provide
better performance. This handles are periodically checked if there are still valid
and if needed updated from the master database. As default only one key is used
for the database lookup, but the additional usage of a second one is possible.
</para>

<para>Changes in the master database are autodetected. For better performance it is
possible to use one read-only instance, that is locally installed, and write only
errors and other status information to a central master database.
Expand All @@ -82,7 +82,7 @@
<itemizedlist>
<listitem>
<para>
<emphasis>a database module</emphasis> necessary to connect to the
<emphasis>a database module</emphasis> necessary to connect to the
master database and to the distributed databases.
</para>
</listitem>
Expand Down Expand Up @@ -155,7 +155,7 @@ modparam("p_usrloc", "read_db_url", "mysql://user:passwd@localhost/db")
</emphasis>
</para>
<example>
<title>Set <varname>reg_db_table</varname> parameter</title>
<title>Set <varname>reg_db_table</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("p_usrloc", "reg_db_table", "locdb")
Expand Down Expand Up @@ -185,7 +185,7 @@ modparam("p_usrloc", "id_column", "id")
<section>
<title><varname>num_column</varname> (string)</title>
<para>
Specifies the column where the associated number of the distributed
Specifies the column where the associated number of the distributed
database is stored. For each distributed database ID there
must be at least two databases available, the databases above
the second are ignored.
Expand Down Expand Up @@ -266,7 +266,7 @@ modparam("p_usrloc", "failover_time_column", "fail")
<section>
<title><varname>spare_flag_column</varname> (string)</title>
<para>
Specifies the column where the spare flag of the location
Specifies the column where the spare flag of the location
databases is stored. It is possible to declare an entry in
the p_usrloc table as spare which is used in a failover.
Due to the fact that the data is stored in two databases and
Expand All @@ -290,7 +290,7 @@ modparam("p_usrloc", "spare_flag_column", "spare")
<section>
<title><varname>error_column</varname> (string)</title>
<para>
Specifies the column where the errors of the distributed
Specifies the column where the errors of the distributed
databases are stored. Each call to db_handle_error increases
the error counter. After exceeding the error threshold, the
database's status is set to off.
Expand Down Expand Up @@ -508,7 +508,7 @@ modparam("p_usrloc", "write_on_master_db", "0")
<section>
<title><varname>mdb_availability_control</varname>(str)</title>
<para>
Checks the master database in certain time intervals specified by the <quote>retry_interval</quote> parameter. Overwrites the <quote>write_on_master_db</quote> parameter based on the reachability of master database. If the master db is unavailable then the aforementioned parameter will be deactivated.
Checks the master database in certain time intervals specified by the <quote>retry_interval</quote> parameter. Overwrites the <quote>write_on_master_db</quote> parameter based on the reachability of master database. If the master db is unavailable then the aforementioned parameter will be deactivated.
</para>
<para>
<emphasis>
Expand All @@ -527,7 +527,7 @@ modparam("p_usrloc", "mdb_availability_control", 1)
<section>
<title><varname>write_on_db</varname> (int)</title>
<para>
Sets the write access to the distributed databases. If set
Sets the write access to the distributed databases. If set
to 0, no write operations are permitted on the databases.
</para>
<para>
Expand Down Expand Up @@ -665,7 +665,7 @@ modparam("p_usrloc", "db_ops_ruid", 2)
</programlisting>
</example>
</section>

<section>
<title><varname>db_update_as_insert</varname> (string)</title>
<para>
Expand Down Expand Up @@ -844,21 +844,21 @@ modparam("p_usrloc", "db_mode", 2)
<title><varname>db_url</varname></title> <para> This parameters is now obsolete, and replaced by specific p_usrloc parameters</para>
</section>
</section>


<section>

<section>
<title>Installation &amp; Running</title>
<section>
<title>Database setup</title>
<section>
<title>Configuration Table</title>
<para>
Before running &kamailio; with p_usrloc, you have to setup the master database
table where the module will find data about the distributed databases.
table where the module will find data about the distributed databases.
For that, if the table was not created by the installation script or you choose
to install everything by yourself you can use the p_usrloc-create.sql
<acronym>SQL</acronym> script in the database directories in the
utils/kamctl/mysql/ folder as template.
<acronym>SQL</acronym> script in the database directories in the
utils/kamctl/mysql/ folder as template.
Database and table name can be set with module parameters so they
can be changed, but the name of the columns must be as they are
in the <acronym>SQL</acronym> script.
Expand All @@ -881,7 +881,7 @@ modparam("p_usrloc", "db_mode", 2)
</programlisting>
<para>The URLs are omitted for a better overview, but you can use
standard &kamailio; database URLs like
&defaultdb;
&defaultdb;
Databases don't need to be on different hosts, e.g. for testing purposes.
</para>
</example>
Expand All @@ -893,7 +893,7 @@ modparam("p_usrloc", "db_mode", 2)
</section>
<section>
<title>Maintenance</title>

<para>The module supports the deactivation of redundant databases for maintenance
reasons. This can be done by setting the status column of the respective database
in the p_usrloc to the value <quote>2</quote>. This setting is autodetected from
Expand All @@ -915,15 +915,15 @@ modparam("p_usrloc", "db_mode", 2)
is set to the default value again. The database is then also used to read contacts
from, the cluster is in normal operation with full redundancy again.
</para>

</section>
<section>
<title>Additional configuration</title>

<para>As this module is only used internally from other modules, there is no
additional configuration except for the module parameter setup necessary.
</para>

</section>
</section>
</chapter>
Expand Down
8 changes: 4 additions & 4 deletions src/modules/p_usrloc/doc/p_usrloc_devel.xml
Expand Up @@ -22,12 +22,12 @@
</title>
<para>
Import the <acronym>dbd</acronym> API, setup the master database connection.

</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>api</emphasis> - Pointer to distributed database API structure
<para><emphasis>api</emphasis> - Pointer to distributed database API structure
</para>
</listitem>
</itemizedlist>
Expand Down Expand Up @@ -129,8 +129,8 @@
db_key_t* _k, db_val_t* _v, int _n)</function>
</title>
<para>
Lookup the first and if needed the second key, and insert on duplicate key update
the given values in the chosen databases. This is like an insert, but update
Lookup the first and if needed the second key, and insert on duplicate key update
the given values in the chosen databases. This is like an insert, but update
if the key already exist.
</para>
<para>Meaning of the parameters is as follows:</para>
Expand Down

0 comments on commit 7d2ad3f

Please sign in to comment.