17 Sep
2013
17 Sep
'13
5:01 p.m.
Module: sip-router
Branch: master
Commit: af8923703276bb41ea269cc19a7812fea325a250
URL:
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=af89237…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: Tue Sep 17 15:00:37 2013 +0200
debugger: reset_msgid parameter was in functions sections
- added some section ids
---
modules/debugger/README | 40 ++++++++--------
modules/debugger/doc/debugger_admin.xml | 74 ++++++++++++++++---------------
2 files changed, 58 insertions(+), 56 deletions(-)
diff --git a/modules/debugger/README b/modules/debugger/README
index efef14b..b63f333 100644
--- a/modules/debugger/README
+++ b/modules/debugger/README
@@ -37,12 +37,12 @@ Daniel-Constantin Mierla
3.10. mod_level (str)
3.11. log_assign (int)
3.12. cfgpkgcheck (int)
+ 3.13. reset_msgid (int)
4. Functions
4.1. dbg_breakpoint(mode)
4.2. dbg_pv_dump([mask] [, level])
- 4.3. reset_msgid (int)
5. Exported RPC Functions
@@ -68,9 +68,9 @@ Daniel-Constantin Mierla
1.10. Set mod_level parameter
1.11. Set log_assign parameter
1.12. Set cfgpkgcheck parameter
- 1.13. dbg_breakpoint usage
- 1.14. dbg_pv_dump usage
- 1.15. Set reset_msgid parameter
+ 1.13. Set reset_msgid parameter
+ 1.14. dbg_breakpoint usage
+ 1.15. dbg_pv_dump usage
Chapter 1. Admin Guide
@@ -96,12 +96,12 @@ Chapter 1. Admin Guide
3.10. mod_level (str)
3.11. log_assign (int)
3.12. cfgpkgcheck (int)
+ 3.13. reset_msgid (int)
4. Functions
4.1. dbg_breakpoint(mode)
4.2. dbg_pv_dump([mask] [, level])
- 4.3. reset_msgid (int)
5. Exported RPC Functions
@@ -166,6 +166,7 @@ Chapter 1. Admin Guide
3.10. mod_level (str)
3.11. log_assign (int)
3.12. cfgpkgcheck (int)
+ 3.13. reset_msgid (int)
3.1. cfgtrace (int)
@@ -315,11 +316,22 @@ modparam("debugger", "log_assign", 1)
modparam("debugger", "cfgpkgcheck", 1)
...
+3.13. reset_msgid (int)
+
+ Used to enable or disable the ability to reset the msgid ($mi) through
+ the dbg.reset_msgid RPC command. (0 - disabled, 1 - enabled).
+
+ Default value is "0" - feature disabled.
+
+ Example 1.13. Set reset_msgid parameter
+...
+modparam("debugger", "reset_msgid", 1)
+...
+
4. Functions
4.1. dbg_breakpoint(mode)
4.2. dbg_pv_dump([mask] [, level])
- 4.3. reset_msgid (int)
4.1. dbg_breakpoint(mode)
@@ -330,7 +342,7 @@ modparam("debugger", "cfgpkgcheck", 1)
Note that this version of the module does not export this anchors to
RPC for interactive debugging (temporarily disabled).
- Example 1.13. dbg_breakpoint usage
+ Example 1.14. dbg_breakpoint usage
...
if($si=="10.0.0.10")
dbg_breakpoint("1");
@@ -358,7 +370,7 @@ if($si=="10.0.0.10")
* L_INFO - log level 2
* L_DBG - log level 3
- Example 1.14. dbg_pv_dump usage
+ Example 1.15. dbg_pv_dump usage
...
$var(temp) = 1;
$avp(s:more_avp) = 2;
@@ -381,18 +393,6 @@
vp(x)":[{"different":["foo"]},{"other":[2,1],"more":["hi","bye"]}],"$T_branch_id
x":0,"$var(empty)":0}
...
-4.3. reset_msgid (int)
-
- Used to enable or disable the ability to reset the msgid ($mi) through
- the dbg.reset_msgid RPC command. (0 - disabled, 1 - enabled).
-
- Default value is "0" - feature disabled.
-
- Example 1.15. Set reset_msgid parameter
-...
-modparam("debugger", "reset_msgid", 1)
-...
-
5. Exported RPC Functions
5.1. dbg.ls
diff --git a/modules/debugger/doc/debugger_admin.xml
b/modules/debugger/doc/debugger_admin.xml
index 46d0cea..3fa272f 100644
--- a/modules/debugger/doc/debugger_admin.xml
+++ b/modules/debugger/doc/debugger_admin.xml
@@ -74,7 +74,7 @@
</section>
<section>
<title>Parameters</title>
- <section>
+ <section id="dbg.p.cfgtrace">
<title><varname>cfgtrace</varname> (int)</title>
<para>
Control whether the config script trace is enabled or disabled
@@ -96,7 +96,7 @@ modparam("debugger", "cfgtrace", 1)
</example>
</section>
- <section>
+ <section id="dbg.p.breakpoint">
<title><varname>breakpoint</varname> (int)</title>
<para>
Control whether every line (global) breakpoint is enabled
@@ -117,7 +117,7 @@ modparam("debugger", "breakpoint", 1)
</example>
</section>
- <section>
+ <section id="dbg.p.log_level">
<title><varname>log_level</varname> (int)</title>
<para>
What log level is to be used to print module-specific messages.
@@ -137,7 +137,7 @@ modparam("debugger", "log_level", 1)
</example>
</section>
- <section>
+ <section id="dbg.p.log_facility">
<title><varname>log_facility</varname> (str)</title>
<para>
Which log facility is to be used to print module-specific messages.
@@ -159,7 +159,7 @@ modparam("debugger", "log_facility",
"LOG_DAEMON")
</example>
</section>
- <section>
+ <section id="dbg.p.log_prefix">
<title><varname>log_prefix</varname> (str)</title>
<para>
String to print before any module-specific messages.
@@ -179,7 +179,7 @@ modparam("debugger", "log_prefix",
"from-debugger-with-love:")
</example>
</section>
- <section>
+ <section id="dbg.p.step_usleep">
<title><varname>step_usleep</varname> (int)</title>
<para>
Microseconds to sleep before checking for new commands when
@@ -200,7 +200,7 @@ modparam("debugger", "step_usleep", 500000)
</example>
</section>
- <section>
+ <section id="dbg.p.step_loops">
<title><varname>step_loops</varname> (int)</title>
<para>
How many sleeps of 'step_usleep' the RPC process performs when
@@ -223,11 +223,12 @@ modparam("debugger", "step_loops", 100)
</example>
</section>
- <section>
+ <section id="dbg.p.mod_hash_size">
<title><varname>mod_hash_size</varname> (int)</title>
<para>
Used to compute power of two as size of internal hash table to store levels
- per module (e.g., if its set to 4, internal hash table has 16 slots). This parameter is
accesible readonly via the Kamailio config framework.
+ per module (e.g., if its set to 4, internal hash table has 16 slots). This
+ parameter is accesible readonly via the Kamailio config framework.
</para>
<para>
<emphasis>
@@ -244,10 +245,11 @@ modparam("debugger", "mod_hash_size", 5)
</example>
</section>
- <section>
+ <section id="dbg.p.mod_level_mode">
<title><varname>mod_level_mode</varname> (int)</title>
<para>
- Enable or disable per module log level (0 - disabled, 1 - enabled). This
parameter is tunable via the Kamailio config framework.
+ Enable or disable per module log level (0 - disabled, 1 - enabled).
+ This parameter is tunable via the Kamailio config framework.
</para>
<para>
<emphasis>
@@ -264,7 +266,7 @@ modparam("debugger", "mod_level_mode", 1)
</example>
</section>
- <section>
+ <section id="dbg.p.mod_level">
<title><varname>mod_level</varname> (str)</title>
<para>
Specify module log level - the value must be in the format:
@@ -282,7 +284,7 @@ modparam("debugger", "mod_level",
"tm=3")
</example>
</section>
- <section>
+ <section id="dbg.p.log_assign">
<title><varname>log_assign</varname> (int)</title>
<para>
Enable or disable log assign actions on config (0 - disabled, 1 - enabled).
@@ -323,11 +325,32 @@ modparam("debugger", "cfgpkgcheck", 1)
</example>
</section>
+ <section id="dbg.p.reset_msgid">
+ <title><varname>reset_msgid</varname> (int)</title>
+ <para>
+ Used to enable or disable the ability to reset the msgid ($mi)
+ through the dbg.reset_msgid RPC command. (0 - disabled, 1 - enabled).
+ </para>
+ <para>
+ <emphasis>
+ Default value is <quote>0</quote> - feature disabled.
+ </emphasis>
+ </para>
+ <example>
+ <title>Set <varname>reset_msgid</varname> parameter</title>
+ <programlisting format="linespecific">
+...
+modparam("debugger", "reset_msgid", 1)
+...
+</programlisting>
+ </example>
+ </section>
+
</section>
<section>
<title>Functions</title>
- <section>
+ <section id="dbg.f.db_breakpoint">
<title>
<function moreinfo="none">dbg_breakpoint(mode)</function>
</title>
@@ -351,7 +374,7 @@ if($si=="10.0.0.10")
</example>
</section>
- <section>
+ <section id="dbg.f.dbg_pv_dump">
<title>
<function moreinfo="none">dbg_pv_dump([mask] [,
level])</function>
</title>
@@ -436,27 +459,6 @@ dbg_pv_dump(30, "L_DBG");
</example>
</section>
- <section>
- <title><varname>reset_msgid</varname> (int)</title>
- <para>
- Used to enable or disable the ability to reset the msgid ($mi)
- through the dbg.reset_msgid RPC command. (0 - disabled, 1 - enabled).
- </para>
- <para>
- <emphasis>
- Default value is <quote>0</quote> - feature disabled.
- </emphasis>
- </para>
- <example>
- <title>Set <varname>reset_msgid</varname> parameter</title>
- <programlisting format="linespecific">
-...
-modparam("debugger", "reset_msgid", 1)
-...
-</programlisting>
- </example>
- </section>
-
</section>
<section>