26 May
2011
26 May
'11
1:09 p.m.
Module: sip-router
Branch: tteras/db_sqlite
Commit: f5d5348c0fd5a1b1bd204ef4bd34238c171ae047
URL:
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=f5d5348…
Author: Timo Teräs <timo.teras(a)iki.fi>
Committer: Timo Teräs <timo.teras(a)iki.fi>
Date: Thu May 26 13:07:10 2011 +0300
db_sqlite(k): add docbook docs
---
modules_k/db_sqlite/README | 6 +--
modules_k/db_sqlite/doc/Makefile | 4 ++
modules_k/db_sqlite/doc/db_sqlite.xml | 45 +++++++++++++++
modules_k/db_sqlite/doc/db_sqlite_admin.xml | 78 +++++++++++++++++++++++++++
4 files changed, 129 insertions(+), 4 deletions(-)
diff --git a/modules_k/db_sqlite/README b/modules_k/db_sqlite/README
index a19b2a6..2679f99 100644
--- a/modules_k/db_sqlite/README
+++ b/modules_k/db_sqlite/README
@@ -22,7 +22,6 @@ Timo Teräs
2.2. External Libraries or Applications
3. Exported Parameters
-
4. Exported Functions
Chapter 1. Admin Guide
@@ -36,13 +35,12 @@ Chapter 1. Admin Guide
2.2. External Libraries or Applications
3. Exported Parameters
-
4. Exported Functions
1. Overview
- The module is an implementation of the internal DB API v1 connector
- for SQlite 3 file.
+ The module is an implementation of the internal DB API v1 connector for
+ SQlite 3 file.
2. Dependencies
diff --git a/modules_k/db_sqlite/doc/Makefile b/modules_k/db_sqlite/doc/Makefile
new file mode 100644
index 0000000..e32e35e
--- /dev/null
+++ b/modules_k/db_sqlite/doc/Makefile
@@ -0,0 +1,4 @@
+docs = db_sqlite.xml
+
+docbook_dir=../../../docbook
+include $(docbook_dir)/Makefile.module
diff --git a/modules_k/db_sqlite/doc/db_sqlite.xml
b/modules_k/db_sqlite/doc/db_sqlite.xml
new file mode 100644
index 0000000..de1c53d
--- /dev/null
+++ b/modules_k/db_sqlite/doc/db_sqlite.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
+
+<book xmlns:xi="http://www.w3.org/2001/XInclude">
+ <bookinfo>
+ <title>SQlite Module</title>
+ <productname class="trade">&kamailioname;</productname>
+ <authorgroup>
+ <author>
+ <firstname>Timo</firstname>
+ <surname>Ter�s</surname>
+ <address>
+ <email>timo.teras(a)iki.fi</email>
+ </address>
+ </author>
+ <editor>
+ <firstname>Timo</firstname>
+ <surname>Ter�s</surname>
+ <address>
+ <email>timo.teras(a)iki.fi</email>
+ </address>
+ </editor>
+ </authorgroup>
+ <copyright>
+ <year>2011</year>
+ <holder>Timo Ter�s</holder>
+ </copyright>
+ <revhistory>
+ <revision>
+ <revnumber>$Revision$</revnumber>
+ <date>$Date$</date>
+ </revision>
+ </revhistory>
+ </bookinfo>
+ <toc></toc>
+
+ <xi:include href="db_sqlite_admin.xml"/>
+</book>
diff --git a/modules_k/db_sqlite/doc/db_sqlite_admin.xml
b/modules_k/db_sqlite/doc/db_sqlite_admin.xml
new file mode 100644
index 0000000..f60b799
--- /dev/null
+++ b/modules_k/db_sqlite/doc/db_sqlite_admin.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
+
+<!-- Module User's Guide -->
+
+<chapter>
+ <title>&adminguide;</title>
+
+ <section>
+ <title>Overview</title>
+ <para>The module is an implementation of the internal DB API v1 connector
+ for SQlite 3 file.</para>
+ </section>
+ <section>
+ <title>Dependencies</title>
+ <section>
+ <title>&kamailio; Modules</title>
+ <para>
+ The following modules must be loaded before this module:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>No dependencies on other &kamailio; modules</emphasis>.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section>
+ <title>External Libraries or Applications</title>
+ <para>
+ The following libraries or applications must be installed before running
+ &kamailio; with this module loaded:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis>SQlite 3 library</emphasis> - e.g., libsqlite3-0
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>SQlite 3 devel library</emphasis> - to compile
+ the module e.g. libsqlite3-dev
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>SQlite 3 utilities</emphasis> - for kamdbctl
+ e.g. sqlite3
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ </section>
+
+ <section>
+ <title>Exported Parameters</title>
+ <para>
+ NONE
+ </para>
+ </section>
+
+ <section>
+ <title>Exported Functions</title>
+ <para>
+ NONE
+ </para>
+ </section>
+</chapter>
+