Merge pull request #583 from mslehto/known_limits

modules/*/doc: reorganize “Known limitations”
kamailio · Apr 26, 2016 · 14e0f68 · 14e0f68
2 parents 0dfd44a + fc0711c
commit 14e0f68
Show file tree

Hide file tree

Showing 14 changed files with 721 additions and 766 deletions.
diff --git a/modules/db_mongodb/README b/modules/db_mongodb/README
@@ -10,23 +10,21 @@ Daniel-Constantin Mierla
 
    <miconda@gmail.com>
 
-   Copyright � 2014 asipto.com
+   Copyright © 2014 asipto.com
      __________________________________________________________________
 
    Table of Contents
 
    1. Admin Guide
 
         1. Overview
+        2. Limitations
+        3. Dependencies
 
-              1.1. Limitations
+              3.1. Kamailio Modules
+              3.2. External Libraries or Applications
 
-        2. Dependencies
-
-              2.1. Kamailio Modules
-              2.2. External Libraries or Applications
-
-        3. Usage
+        4. Usage
 
    List of Examples
 
@@ -37,20 +35,16 @@ Chapter 1. Admin Guide
    Table of Contents
 
    1. Overview
+   2. Limitations
+   3. Dependencies
 
-        1.1. Limitations
-
-   2. Dependencies
+        3.1. Kamailio Modules
+        3.2. External Libraries or Applications
 
-        2.1. Kamailio Modules
-        2.2. External Libraries or Applications
-
-   3. Usage
+   4. Usage
 
 1. Overview
 
-   1.1. Limitations
-
    This module provides DB APIv1 connector for MongoDB NoSQL server.
 
    It can be used as a replacement for other database modules such as
@@ -60,33 +54,33 @@ Chapter 1. Admin Guide
 
    You can read more about MongoDB at: http://www.mongodb.org.
 
-1.1. Limitations
+2. Limitations
 
-     * This module has implemented the equivalent operations for INSERT,
-       UPDATE, DELETE and SELECT. The match condition (WHERE clause) works
-       with the operators: equal, not equal, greater than, less than,
-       equal or greater than, equal or less than. Raw query is not
-       implemented inside this module, use ndb_mongodb for sending any
-       kind of command to a MongoDB server.
+   This module has implemented the equivalent operations for INSERT,
+   UPDATE, DELETE and SELECT. The match condition (WHERE clause) works
+   with the operators: equal, not equal, greater than, less than, equal or
+   greater than, equal or less than. Raw query is not implemented inside
+   this module, use ndb_mongodb for sending any kind of command to a
+   MongoDB server.
 
-2. Dependencies
+3. Dependencies
 
-   2.1. Kamailio Modules
-   2.2. External Libraries or Applications
+   3.1. Kamailio Modules
+   3.2. External Libraries or Applications
 
-2.1. Kamailio Modules
+3.1. Kamailio Modules
 
    The following modules must be loaded before this module:
      * none.
 
-2.2. External Libraries or Applications
+3.2. External Libraries or Applications
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
      * mongo-c-driver - available at
        https://github.com/mongodb/mongo-c-driver
 
-3. Usage
+4. Usage
 
    Load the module and set the the DB URL for specific modules to:
    mongodb://username:password@host:port/database. Username, password and

diff --git a/modules/db_mongodb/doc/db_mongodb_admin.xml b/modules/db_mongodb/doc/db_mongodb_admin.xml
@@ -28,11 +28,10 @@
 		You can read more about MongoDB at:
 		<ulink url="http://www.mongodb.org">http://www.mongodb.org</ulink>.
 	</para>
+	</section>
 
 	<section>
 	<title>Limitations</title>
-	<itemizedlist>
-	<listitem>
 	<para>
 		This module has implemented the equivalent operations for INSERT,
 		UPDATE, DELETE and SELECT. The match condition (WHERE clause)
@@ -41,9 +40,6 @@
 		implemented inside this module, use ndb_mongodb for sending any
 		kind of command to a MongoDB server.
 	</para>
-	</listitem>
-	</itemizedlist>
-	</section>
 	</section>
 
 	<section>

diff --git a/modules/db_text/README b/modules/db_text/README
@@ -10,14 +10,10 @@ Ovidiu Sas
 
    <osas@voipembedded.com>
 
-Edited by
-
 Daniel-Constantin Mierla
 
    <miconda@gmail.com>
 
-Edited by
-
 Olle E. Johansson
 
    <oej@edvina.net>
@@ -33,26 +29,26 @@ Olle E. Johansson
 
               1.1. Design of dbtext engine
               1.2. Internal format of a dbtext table
-              1.3. Existing limitations
 
-        2. Dependencies
+        2. Known limitations
+        3. Dependencies
 
-              2.1. Kamailio modules
-              2.2. External libraries or applications
+              3.1. Kamailio modules
+              3.2. External libraries or applications
 
-        3. Parameters
+        4. Parameters
 
-              3.1. db_mode (integer)
-              3.2. emptystring (integer)
-              3.3. file_buffer_size (integer)
+              4.1. db_mode (integer)
+              4.2. emptystring (integer)
+              4.3. file_buffer_size (integer)
 
-        4. Exported RPC Functions
+        5. Exported RPC Functions
 
-              4.1. db_text.dump
+              5.1. db_text.dump
 
-        5. Installation and Running
+        6. Installation and Running
 
-              5.1. Using db_text with a basic Kamailio configuration
+              6.1. Using db_text with a basic Kamailio configuration
 
    2. Developer Guide
 
@@ -78,32 +74,31 @@ Chapter 1. Admin Guide
 
         1.1. Design of dbtext engine
         1.2. Internal format of a dbtext table
-        1.3. Existing limitations
 
-   2. Dependencies
+   2. Known limitations
+   3. Dependencies
 
-        2.1. Kamailio modules
-        2.2. External libraries or applications
+        3.1. Kamailio modules
+        3.2. External libraries or applications
 
-   3. Parameters
+   4. Parameters
 
-        3.1. db_mode (integer)
-        3.2. emptystring (integer)
-        3.3. file_buffer_size (integer)
+        4.1. db_mode (integer)
+        4.2. emptystring (integer)
+        4.3. file_buffer_size (integer)
 
-   4. Exported RPC Functions
+   5. Exported RPC Functions
 
-        4.1. db_text.dump
+        5.1. db_text.dump
 
-   5. Installation and Running
+   6. Installation and Running
 
-        5.1. Using db_text with a basic Kamailio configuration
+        6.1. Using db_text with a basic Kamailio configuration
 
 1. Overview
 
    1.1. Design of dbtext engine
    1.2. Internal format of a dbtext table
-   1.3. Existing limitations
 
    The module implements a simplified database engine based on text files.
    It can be used by Kamailio DB interface instead of other database
@@ -187,36 +182,36 @@ username(str) password(str) ha1(str) domain(str) ha1b(str)
 suser:supasswd:xxx:alpha.org:xxx
 ...
 
-1.3. Existing limitations
+2. Known limitations
 
    This database interface does not support data insertion with default
    values. All such values specified in the database template are ignored.
    So its advisable to specify all data for a column at insertion
    operations.
 
-2. Dependencies
+3. Dependencies
 
-   2.1. Kamailio modules
-   2.2. External libraries or applications
+   3.1. Kamailio modules
+   3.2. External libraries or applications
 
-2.1. Kamailio modules
+3.1. Kamailio modules
 
    These modules must be loaded before this module:
      * none.
 
-2.2. External libraries or applications
+3.2. External libraries or applications
 
    These libraries or applications must be installed before running
    Kamailio with this module:
      * none.
 
-3. Parameters
+4. Parameters
 
-   3.1. db_mode (integer)
-   3.2. emptystring (integer)
-   3.3. file_buffer_size (integer)
+   4.1. db_mode (integer)
+   4.2. emptystring (integer)
+   4.3. file_buffer_size (integer)
 
-3.1. db_mode (integer)
+4.1. db_mode (integer)
 
    Set caching mode (0) or non-caching mode (1). In caching mode, data is
    loaded at startup. In non-caching mode, the module check every time a
@@ -230,7 +225,7 @@ suser:supasswd:xxx:alpha.org:xxx
 modparam("db_text", "db_mode", 1)
 ...
 
-3.2. emptystring (integer)
+4.2. emptystring (integer)
 
    db_text by default handles an empty string as a NULL value. Some
    modules, like the dialplan module, does not accept NULL strings. If you
@@ -244,7 +239,7 @@ modparam("db_text", "db_mode", 1)
 modparam("db_text", "emptystring", 1)
 ...
 
-3.3. file_buffer_size (integer)
+4.3. file_buffer_size (integer)
 
    size of the buffer used to read the text file. Some presence tables
    have columns with large content.
@@ -256,11 +251,11 @@ modparam("db_text", "emptystring", 1)
 modparam("db_text", "file_buffer_size", 8192)
 ...
 
-4. Exported RPC Functions
+5. Exported RPC Functions
 
-   4.1. db_text.dump
+   5.1. db_text.dump
 
-4.1.  db_text.dump
+5.1.  db_text.dump
 
    Write back to hard drive all modified tables.
 
@@ -271,9 +266,9 @@ modparam("db_text", "file_buffer_size", 8192)
    RPC Command Format:
         kamcmd db_text.dump
 
-5. Installation and Running
+6. Installation and Running
 
-   5.1. Using db_text with a basic Kamailio configuration
+   6.1. Using db_text with a basic Kamailio configuration
 
    Compile the module and load it instead of mysql or other DB modules.
 
@@ -291,7 +286,7 @@ loadmodule "/path/to/kamailio/modules_k/db_text.so"
 modparam("module_name", "db_url", "text:///path/to/dbtext/database")
 ...
 
-5.1. Using db_text with a basic Kamailio configuration
+6.1. Using db_text with a basic Kamailio configuration
 
    Here are definitions for the most important tables as well as a basic
    configuration file to use db_text with Kamailio. The table structures
@@ -305,17 +300,17 @@ modparam("module_name", "db_url", "text:///path/to/dbtext/database")
 
    Example 1.8. Definition of 'subscriber' table (one line)
 ...
-username(str) domain(str) password(str) first_name(str) last_name(str) phone(st
-r) email_address(str) datetime_created(int) datetime_modified(int) confirmation
-(str) flag(str) sendnotification(str) greeting(str) ha1(str) ha1b(str) perms(st
-r) allow_find(str) timezone(str,null) rpid(str,null)
+username(str) domain(str) password(str) first_name(str) last_name(str) phone(str
+) email_address(str) datetime_created(int) datetime_modified(int) confirmation(s
+tr) flag(str) sendnotification(str) greeting(str) ha1(str) ha1b(str) perms(str)
+allow_find(str) timezone(str,null) rpid(str,null)
 ...
 
    Example 1.9. Definition of 'location' and 'aliases' tables (one line)
 ...
-username(str) domain(str,null) contact(str,null) received(str) expires(int,null
-) q(double,null) callid(str,null) cseq(int,null) last_modified(str) flags(int)
-user_agent(str) socket(str)
+username(str) domain(str,null) contact(str,null) received(str) expires(int,null)
+ q(double,null) callid(str,null) cseq(int,null) last_modified(str) flags(int) us
+er_agent(str) socket(str)
 ...
 
    Example 1.10. Definition of 'version' table and sample records

diff --git a/modules/db_text/doc/db_text_admin.xml b/modules/db_text/doc/db_text_admin.xml
@@ -206,14 +206,14 @@ suser:supasswd:xxx:alpha.org:xxx
 </programlisting>
 		</example>
 		</section>
-		<section>
-		<title>Existing limitations</title>
+	</section>
+	<section>
+	<title>Known limitations</title>
 		<para>This database interface does not support data insertion with
 			default values. All such values specified in the database template
 			are ignored. So its advisable to specify all data for a column at
 			insertion operations.
 		</para>
-		</section>
 	</section>
 	<section>
 	<title>Dependencies</title>