git:master: counters Updating documentation to "book" from "section" - sr-dev

20 Dec 2012

Module: sip-router
Branch: master
Commit: 8b967b4b96765057bb0b8f62ee1dd5b04442b52d
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8b967b4b...
Author: Olle E. Johansson oej@edvina.net
Committer: Olle E. Johansson oej@edvina.net
Date:   Thu Dec 20 08:41:00 2012 +0100
counters Updating documentation to "book" from "section"
Renaming files to avoid collission when aggregating documentation.
---
modules/counters/README                            |   81 +++++++++++---------
 modules/counters/doc/counters.xml                  |   16 ++--
 .../doc/{functions.xml => counters_functions.xml}  |    0
 .../doc/{params.xml => counters_params.xml}        |    0
 modules/counters/doc/{rpc.xml => counters_rpc.xml} |    0
 5 files changed, 52 insertions(+), 45 deletions(-)

diff --git a/modules/counters/README b/modules/counters/README
index 8b3b32c..6a25a45 100644
--- a/modules/counters/README
+++ b/modules/counters/README
@@ -1,4 +1,4 @@
-1. Counters Module
+Counters Module
Andrei Pelinescu-Onciul
@@ -7,35 +7,31 @@ Andrei Pelinescu-Onciul
    Copyright � 2010 iptelorg GmbH
      __________________________________________________________________
-   1.1. Overview
-   1.2. Parameters
+   List of Examples
-        1.2.1. script_counter
-        1.2.2. script_cnt_grp_name
+   1. Create a new script_counter
+   2. Set script_cnt_grp_name in the config file
+   3. cnt_inc usage
+   4. cnt_add usage
+   5. cnt_reset usage
+   6. cnt.get grp counter_name usage
+   7. cnt.reset grp name usage
+   8. cnt.grps_list usage
+   9. cnt.var_list group usage
+   10. cnt.var_list group usage
+   11. cnt.help grp name usage
-   1.3. Functions
-
-        1.3.1. cnt_inc([group.]name)
-        1.3.2. cnt_add([group.]name, number)
-        1.3.3. cnt_reset([group.]name)
-
-   1.4. counters RPC Functions
-
-        1.4.1. cnt.get group counter_name
-        1.4.2. cnt.reset group counter_name
-        1.4.3. cnt.grps_list
-        1.4.4. cnt.var_list group
-        1.4.5. cnt.grp_get_all
-        1.4.6. cnt.help group counter_name
-
-1.1. Overview
+1. Overview
This module exports counters/statistics manipulating script functions
    and RPCs.
-1.2. Parameters
+2. Parameters
-1.2.1. script_counter
+   2.1. script_counter
+   2.2. script_cnt_grp_name
+
+2.1. script_counter
Define a new counter that can be used from the script. The declaration
    might include a group in front of the counter name, separated with '.'.
@@ -46,25 +42,29 @@ Andrei Pelinescu-Onciul
    is "custom script counter". The format of the declaration is:
    [group.]name[( |:)description].
-   Example 1. Create a new script_counter
+   Example 1.  Create a new script_counter
 modparam("counters", "script_counter", "foo")  # script.foo
 modparam("counters", "script_counter", "test.bar")  # test.bar
 modparam("counters", "script_counter", "baz example counter")  # script.baz
 modparam("counters", "script_counter", "test.x:another example") # test.x
-1.2.2. script_cnt_grp_name
+2.2. script_cnt_grp_name
Group name that will be used for the counters defined via the
    script_counter module parameter which do not have a specified group.
Default: "script".
-   Example 2. Set script_cnt_grp_name in the config file
+   Example 2.  Set script_cnt_grp_name in the config file
 modparam("counters", "script_cnt_grp_name", "my_counters")
-1.3. Functions
+3. Functions
+
+   3.1. cnt_inc([group.]name)
+   3.2. cnt_add([group.]name, number)
+   3.3. cnt_reset([group.]name)
-1.3.1. cnt_inc([group.]name)
+3.1.  cnt_inc([group.]name)
Increments the counter group.name. The counter must be defined using
    the script_counter module parameter. If the group name is missing, the
@@ -82,7 +82,7 @@ route {
 ...
 }
-1.3.2. cnt_add([group.]name, number)
+3.2.  cnt_add([group.]name, number)
Adds number the counter group.name. The counter must be defined using
    the script_counter module parameter. If the group name is missing, the
@@ -97,7 +97,7 @@ route {
 ...
 }
-1.3.3. cnt_reset([group.]name)
+3.3.  cnt_reset([group.]name)
Resets the counter group.name. The counter must be defined using the
    script_counter module parameter. If the group name is missing, the
@@ -113,30 +113,37 @@ route {
 ...
 }
-1.4. counters RPC Functions
+4. counters RPC Functions
+
+   4.1. cnt.get group counter_name
+   4.2. cnt.reset group counter_name
+   4.3. cnt.grps_list
+   4.4. cnt.var_list group
+   4.5. cnt.grp_get_all
+   4.6. cnt.help group counter_name
-1.4.1.  cnt.get group counter_name
+4.1.  cnt.get group counter_name
Get the value of the counter identified by group.counter_name.
Example 6. cnt.get grp counter_name usage
  $ sercmd cnt.get script foo
-1.4.2.  cnt.reset group counter_name
+4.2.  cnt.reset group counter_name
Resets the counter identified by group.counter_name.
Example 7. cnt.reset grp name usage
  $ sercmd cnt.reset script foo
-1.4.3.  cnt.grps_list
+4.3.  cnt.grps_list
Lists all the declared counter groups.
Example 8. cnt.grps_list usage
  $ sercmd cnt.grps_list
-1.4.4.  cnt.var_list group
+4.4.  cnt.var_list group
Lists all the names of all the counters belonging to the specified
    group.
@@ -144,14 +151,14 @@ route {
    Example 9. cnt.var_list group usage
  $ sercmd cnt.var_list script
-1.4.5.  cnt.grp_get_all
+4.5.  cnt.grp_get_all
Lists all the counter names and their values in the specified group.
Example 10. cnt.var_list group usage
  $ sercmd cnt.grp_get_all script
-1.4.6.  cnt.help group counter_name
+4.6.  cnt.help group counter_name
Displays the counter description.
diff --git a/modules/counters/doc/counters.xml b/modules/counters/doc/counters.xml
index dd9bae3..ca84a63 100644
--- a/modules/counters/doc/counters.xml
+++ b/modules/counters/doc/counters.xml
@@ -9,8 +9,9 @@
    ]
...
-<section id="counters" xmlns:xi="http://www.w3.org/2001/XInclude">
-	<sectioninfo>
+<book id="counters" xmlns:xi="http://www.w3.org/2001/XInclude">
+	<bookinfo>
+	<title>Counters Module</title>
    <authorgroup>
    	<author>
    	<firstname>Andrei</firstname>
@@ -25,9 +26,8 @@
    	<year>2010</year>
    	<holder>iptelorg GmbH</holder>
    </copyright>
-	</sectioninfo>
+	</bookinfo>
-	<title>Counters Module</title>
<section id="cnts.overview">
    <title>Overview</title>
@@ -37,9 +37,9 @@
    </para>
    </section>
-	<xi:include href="params.xml"/>
-	<xi:include href="functions.xml"/>
-	<xi:include href="rpc.xml"/>
+	<xi:include href="counters_params.xml"/>
+	<xi:include href="counters_functions.xml"/>
+	<xi:include href="counters_rpc.xml"/>
-</section>
+</book>
diff --git a/modules/counters/doc/functions.xml b/modules/counters/doc/counters_functions.xml
similarity index 100%
rename from modules/counters/doc/functions.xml
rename to modules/counters/doc/counters_functions.xml
diff --git a/modules/counters/doc/params.xml b/modules/counters/doc/counters_params.xml
similarity index 100%
rename from modules/counters/doc/params.xml
rename to modules/counters/doc/counters_params.xml
diff --git a/modules/counters/doc/rpc.xml b/modules/counters/doc/counters_rpc.xml
similarity index 100%
rename from modules/counters/doc/rpc.xml
rename to modules/counters/doc/counters_rpc.xml

    