Browse Source

db_flatstore Minor README edits

Olle E. Johansson 12 years ago
parent
commit
326772a152

+ 11 - 15
modules/db_flatstore/README

@@ -1,4 +1,4 @@
-1. Db_flatstore Module
+Db_flatstore Module
 
 
 Jan Janak
 Jan Janak
 
 
@@ -8,19 +8,13 @@ Jan Janak
    Copyright © 2004, 2005 FhG FOKUS
    Copyright © 2004, 2005 FhG FOKUS
      __________________________________________________________________
      __________________________________________________________________
 
 
-   1.1. Overview
+1. Overview
 
 
-        1.1.1. Rotating Log Files
+   1.1. Rotating Log Files
 
 
-   1.2. Parameters
-
-        1.2.1. flush (integer)
-
-1.1. Overview
-
-   Db_flatstore is one of so-called SIP Router database modules. It does
-   not export any functions executable from the configuration scripts, but
-   it exports a subset of functions from the database API and thus other
+   Db_flatstore is one of the SIP Router database modules. It does not
+   export any functions executable from the configuration scripts, but it
+   exports a subset of functions from the database API and thus other
    modules can use it as a database driver, instead of, for example, the
    modules can use it as a database driver, instead of, for example, the
    Mysql module.
    Mysql module.
 
 
@@ -60,7 +54,7 @@ modparam("acc", "db_url", "flatstore:/var/log/acc")
    simply concatenate the contents of files with the same table name but
    simply concatenate the contents of files with the same table name but
    different process id.
    different process id.
 
 
-1.1.1. Rotating Log Files
+1.1. Rotating Log Files
 
 
    The module implements a SIP Router management interface command called
    The module implements a SIP Router management interface command called
    flatstore.rotate. When SIP Router receives the command it will close
    flatstore.rotate. When SIP Router receives the command it will close
@@ -86,9 +80,11 @@ sercmd flatstore.rotate
        traffic on the SIP server.
        traffic on the SIP server.
      * Move the renamed files somewhere else and process them.
      * Move the renamed files somewhere else and process them.
 
 
-1.2. Parameters
+2. Parameters
+
+   2.1. flush (integer)
 
 
-1.2.1. flush (integer)
+2.1. flush (integer)
 
 
    Enable or disable flushing after each write.
    Enable or disable flushing after each write.
 
 

+ 7 - 7
modules/db_flatstore/doc/db_flatstore.xml

@@ -8,8 +8,9 @@
 
 
 ]>
 ]>
 
 
-<section id="flatstore" xmlns:xi="http://www.w3.org/2001/XInclude">
-    <sectioninfo>
+<book id="flatstore" xmlns:xi="http://www.w3.org/2001/XInclude">
+    <bookinfo>
+    	<title>Db_flatstore Module</title>
 	<authorgroup>
 	<authorgroup>
 	    <author>
 	    <author>
 		<firstname>Jan</firstname>
 		<firstname>Jan</firstname>
@@ -23,14 +24,13 @@
 	    <year>2005</year>
 	    <year>2005</year>
 	    <holder>FhG FOKUS</holder>
 	    <holder>FhG FOKUS</holder>
 	</copyright>
 	</copyright>
-    </sectioninfo>
+    </bookinfo>
 
 
-    <title>Db_flatstore Module</title>
 
 
     <section id="flatstore.overview">
     <section id="flatstore.overview">
 	<title>Overview</title>
 	<title>Overview</title>
 	<para>
 	<para>
-	    Db_flatstore is one of so-called &siprouter; database modules. It does
+	    Db_flatstore is one of the &siprouter; database modules. It does
 	    not export any functions executable from the configuration scripts,
 	    not export any functions executable from the configuration scripts,
 	    but it exports a subset of functions from the database API and thus
 	    but it exports a subset of functions from the database API and thus
 	    other modules can use it as a database driver, instead of, for
 	    other modules can use it as a database driver, instead of, for
@@ -131,6 +131,6 @@ mv acc_4.log acc_3.log.20050605
 	</section>
 	</section>
     </section>
     </section>
 
 
-    <xi:include href="params.xml"/>
+    <xi:include href="db_flatstore_params.xml"/>
 
 
-</section>
+</book>

+ 0 - 0
modules/db_flatstore/doc/functions.xml → modules/db_flatstore/doc/db_flatstore_functions.xml


+ 0 - 0
modules/db_flatstore/doc/params.xml → modules/db_flatstore/doc/db_flatstore_params.xml