ソースを参照

debugger: some fixes in documentation

Daniel-Constantin Mierla 15 年 前
コミット
e8e3726989
2 ファイル変更20 行追加15 行削除
  1. 10 7
      modules/debugger/README
  2. 10 8
      modules/debugger/doc/debugger_admin.xml

+ 10 - 7
modules/debugger/README

@@ -96,12 +96,13 @@ Chapter 1. Admin Guide
    the config.
    the config.
 
 
    Debugging can be done from local or remote host via RPC interface
    Debugging can be done from local or remote host via RPC interface
-   (e.g., XMLRPC, sercmd).
+   (e.g., XMLRPC, sercmd, siremis).
 
 
    The framework to set breakpoints on specific actions and config lines
    The framework to set breakpoints on specific actions and config lines
-   is not exported to RPC yet, right now each action has an breakpoint.
-   The breakpoint can be enabled/disabled at runtime. Also the config
-   running trace can be enabled/disabled at runtime.
+   is not exported to RPC yet. Each action can be accompanied by an
+   breakpoint or you can use dbg_breakpoint() function to set a breakpoint
+   at certain line. Global breakpoint can be enabled/disabled at runtime.
+   Also the config running trace can be enabled/disabled at runtime.
 
 
    When the SIP router process is stopped at a breakpoint, you can
    When the SIP router process is stopped at a breakpoint, you can
    investigate the values of any pseudo-varaibles. Note that some of
    investigate the values of any pseudo-varaibles. Note that some of
@@ -139,6 +140,8 @@ Chapter 1. Admin Guide
 3.1. cfgtrace (int)
 3.1. cfgtrace (int)
 
 
    Control whether config running trace is enabled or disabled at startup.
    Control whether config running trace is enabled or disabled at startup.
+   You can change the value at runtime without restart, globally or per
+   process.
 
 
    Default value is “0” (disabled).
    Default value is “0” (disabled).
 
 
@@ -149,7 +152,7 @@ modparam("debugger", "cfgtrace", 1)
 
 
 3.2. breakpoint (int)
 3.2. breakpoint (int)
 
 
-   Control whether every line (for now) breakpoint is enabled or disabled
+   Control whether every line (global) breakpoint is enabled or disabled
    at startup.
    at startup.
 
 
    Default value is “0” (disabled).
    Default value is “0” (disabled).
@@ -224,7 +227,7 @@ modparam("debugger", "step_loops", 100)
 
 
 4.1.  dbg_breakpoint(mode)
 4.1.  dbg_breakpoint(mode)
 
 
-   Achor a breakpoint at that line in config. Mode specifies whether the
+   Anchor a breakpoint at that line in config. Mode specifies whether the
    breakpoint is enabled (1) or disabled (0) at startup.
    breakpoint is enabled (1) or disabled (0) at startup.
 
 
    Note that this version does not export this anchors to RPC for
    Note that this version does not export this anchors to RPC for
@@ -282,7 +285,7 @@ if($si=="10.0.0.10")
    Parameters:
    Parameters:
      * _cmd_ : inner command, see next section for the list of available
      * _cmd_ : inner command, see next section for the list of available
        values.
        values.
-     * _pid_ : pid for which to apply the inner command. If it missing,
+     * _pid_ : pid for which to apply the inner command. If it is missing,
        then will be applied for all processes.
        then will be applied for all processes.
      * _params_ : extra params specific for each inner command.
      * _params_ : extra params specific for each inner command.
 
 

+ 10 - 8
modules/debugger/doc/debugger_admin.xml

@@ -24,13 +24,14 @@
 	</para>
 	</para>
 	<para>
 	<para>
 		Debugging can be done from local or remote host via RPC interface (e.g.,
 		Debugging can be done from local or remote host via RPC interface (e.g.,
-		XMLRPC, sercmd).
+		XMLRPC, sercmd, siremis).
 	</para>
 	</para>
 	<para>
 	<para>
 		The framework to set breakpoints on specific actions and config lines
 		The framework to set breakpoints on specific actions and config lines
-		is not exported to RPC yet, right now each action has an breakpoint. The
-		breakpoint can be enabled/disabled at runtime. Also the config running
-		trace can be enabled/disabled at runtime.
+		is not exported to RPC yet. Each action can be accompanied by an
+		breakpoint or you can use dbg_breakpoint() function to set a breakpoint
+		at certain line. Global breakpoint can be enabled/disabled at runtime.
+		Also the config running trace can be enabled/disabled at runtime.
 	</para>
 	</para>
 	<para>
 	<para>
 		When the SIP router process is stopped at a breakpoint, you can
 		When the SIP router process is stopped at a breakpoint, you can
@@ -77,7 +78,8 @@
 	    <title><varname>cfgtrace</varname> (int)</title>
 	    <title><varname>cfgtrace</varname> (int)</title>
 	    <para>
 	    <para>
 			Control whether config running trace is enabled or disabled
 			Control whether config running trace is enabled or disabled
-			at startup.
+			at startup. You can change the value at runtime without
+			restart, globally or per process.
 	    </para>
 	    </para>
 	    <para>
 	    <para>
 		<emphasis>
 		<emphasis>
@@ -97,7 +99,7 @@ modparam("debugger", "cfgtrace", 1)
 	<section>
 	<section>
 	    <title><varname>breakpoint</varname> (int)</title>
 	    <title><varname>breakpoint</varname> (int)</title>
 	    <para>
 	    <para>
-			Control whether every line (for now) breakpoint is enabled
+			Control whether every line (global) breakpoint is enabled
 			or disabled at startup.
 			or disabled at startup.
 	    </para>
 	    </para>
 	    <para>
 	    <para>
@@ -228,7 +230,7 @@ modparam("debugger", "step_loops", 100)
 		<function moreinfo="none">dbg_breakpoint(mode)</function>
 		<function moreinfo="none">dbg_breakpoint(mode)</function>
 	    </title>
 	    </title>
 	    <para>
 	    <para>
-			Achor a breakpoint at that line in config. Mode specifies
+			Anchor a breakpoint at that line in config. Mode specifies
 			whether the breakpoint is enabled (1) or disabled (0) at startup.
 			whether the breakpoint is enabled (1) or disabled (0) at startup.
 	    </para>
 	    </para>
 		<para>
 		<para>
@@ -321,7 +323,7 @@ if($si=="10.0.0.10")
 			the list of available values.</para>
 			the list of available values.</para>
 		</listitem>
 		</listitem>
 		<listitem><para>_pid_ : pid for which to apply the inner command.
 		<listitem><para>_pid_ : pid for which to apply the inner command.
-				If it missing, then will be applied for all processes.</para>
+				If it is missing, then will be applied for all processes.</para>
 		</listitem>
 		</listitem>
 		<listitem><para>_params_ : extra params specific for each inner
 		<listitem><para>_params_ : extra params specific for each inner
 				command.</para>
 				command.</para>