[sr-dev] git:master: db_flatstore Minor README edits

Module: sip-router Branch: master Commit: 326772a1524e3ad6e7c5927cf6edee1f85bc5a5b URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=326772a… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: Thu Dec 20 20:37:09 2012 +0100 db_flatstore Minor README edits --- modules/db_flatstore/README | 26 ++++++++----------- modules/db_flatstore/doc/db_flatstore.xml | 14 +++++----- .../{functions.xml => db_flatstore_functions.xml} | 0 .../doc/{params.xml => db_flatstore_params.xml} | 0 4 files changed, 18 insertions(+), 22 deletions(-) diff --git a/modules/db_flatstore/README b/modules/db_flatstore/README index 52fbcb1..99314cc 100644 --- a/modules/db_flatstore/README +++ b/modules/db_flatstore/README @@ -1,4 +1,4 @@ -1. Db_flatstore Module +Db_flatstore Module Jan Janak @@ -8,19 +8,13 @@ Jan Janak 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 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 different process id. -1.1.1. Rotating Log Files +1.1. Rotating Log Files The module implements a SIP Router management interface command called flatstore.rotate. When SIP Router receives the command it will close @@ -86,9 +80,11 @@ sercmd flatstore.rotate traffic on the SIP server. * 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. diff --git a/modules/db_flatstore/doc/db_flatstore.xml b/modules/db_flatstore/doc/db_flatstore.xml index 13db1a2..bdeb0f3 100644 --- a/modules/db_flatstore/doc/db_flatstore.xml +++ b/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> <author> <firstname>Jan</firstname> @@ -23,14 +24,13 @@ <year>2005</year> <holder>FhG FOKUS</holder> </copyright> - </sectioninfo> + </bookinfo> - <title>Db_flatstore Module</title> <section id="flatstore.overview"> <title>Overview</title> <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, 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 @@ -131,6 +131,6 @@ mv acc_4.log acc_3.log.20050605 </section> </section> - <xi:include href="params.xml"/> + <xi:include href="db_flatstore_params.xml"/> -</section> +</book> diff --git a/modules/db_flatstore/doc/functions.xml b/modules/db_flatstore/doc/db_flatstore_functions.xml similarity index 100% rename from modules/db_flatstore/doc/functions.xml rename to modules/db_flatstore/doc/db_flatstore_functions.xml diff --git a/modules/db_flatstore/doc/params.xml b/modules/db_flatstore/doc/db_flatstore_params.xml similarity index 100% rename from modules/db_flatstore/doc/params.xml rename to modules/db_flatstore/doc/db_flatstore_params.xml