Module: sip-router
Branch: master
Commit: b495e34e507517cfac8ed2c921642c38b0f0262a
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b495e34…
Author: Alex Balashov <abalashov(a)evaristesys.com>
Committer: Alex Balashov <abalashov(a)evaristesys.com>
Date: Wed Oct 6 03:04:09 2010 -0400
Some minor tweaks to documentation for textopsx.
---
modules/textopsx/README | 13 ++++++-------
modules/textopsx/doc/functions.xml | 12 ++++++------
2 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/modules/textopsx/README b/modules/textopsx/README
index cece6b5..73d894b 100644
--- a/modules/textopsx/README
+++ b/modules/textopsx/README
@@ -28,11 +28,10 @@ Daniel-Constantin Mierla
1.2.1. msg_apply_changes()
- Use this function to apply changes done on SIP request content. Be
- careful when using this function -- due to special handling of changes
- done to SIM message buffer so far, using this function might change the
- behaviour of your config as it was so far -- do test properly your
- config!
+ Use this function to apply changes performed on SIP request content. Be
+ careful when using this function; due to special handling of changes
+ done to SIP message buffer so far, using this function might change the
+ behaviour of your config. Do test your config properly!
This function can be used from REQUEST_ROUTE.
@@ -51,8 +50,8 @@ if(msg_apply_changes())
1.2.2. change_reply_status(code, reason)
- Change the status code and reason phrase of a SIP reply in
- onreply_route.
+ Intercept a SIP reply (in an onreply_route) and change its status code
+ and reason phrase prior to propogating it.
Meaning of the parameters is as follows:
* code - Status code.
diff --git a/modules/textopsx/doc/functions.xml b/modules/textopsx/doc/functions.xml
index bc0fc38..9d7d4f6 100644
--- a/modules/textopsx/doc/functions.xml
+++ b/modules/textopsx/doc/functions.xml
@@ -10,11 +10,10 @@
<function moreinfo="none">msg_apply_changes()</function>
</title>
<para>
- Use this function to apply changes done on SIP request content. Be
- careful when using this function -- due to special handling of changes
- done to SIM message buffer so far, using this function might change
- the behaviour of your config as it was so far -- do test properly
- your config!
+ Use this function to apply changes performed on SIP request content. Be
+ careful when using this function; due to special handling of changes
+ done to SIP message buffer so far, using this function might change
+ the behaviour of your config. Do test your config properly!
</para>
<para>
This function can be used from REQUEST_ROUTE.
@@ -42,7 +41,8 @@ if(msg_apply_changes())
<function>change_reply_status(code, reason)</function>
</title>
<para>
- Change the status code and reason phrase of a SIP reply in onreply_route.
+ Intercept a SIP reply (in an onreply_route) and change its status code
+ and reason phrase prior to propogating it.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
Module: sip-router
Branch: master
Commit: 1e471eb0bfa60a40accddfeb01c7bb34259c1dd1
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=1e471eb…
Author: Alex Balashov <abalashov(a)evaristesys.com>
Committer: Alex Balashov <abalashov(a)evaristesys.com>
Date: Wed Oct 6 02:32:23 2010 -0400
Some clarification and cleanup to 'debugger' module docs.
---
modules/debugger/doc/debugger_admin.xml | 54 ++++++++++++++++---------------
1 files changed, 28 insertions(+), 26 deletions(-)
diff --git a/modules/debugger/doc/debugger_admin.xml b/modules/debugger/doc/debugger_admin.xml
index 78d5582..973028c 100644
--- a/modules/debugger/doc/debugger_admin.xml
+++ b/modules/debugger/doc/debugger_admin.xml
@@ -18,9 +18,9 @@
<title>Overview</title>
<para>
This module provides an interactive config file debugger. It can print
- the trace of config execution for a SIP message to log and set
- breakpoints on every config action, allowing to execute step by step the
- config.
+ a trace of config execution for a SIP message to log and set
+ breakpoints on every config action, allowing step-by-step execution of
+ the config.
</para>
<para>
Debugging can be done from local or remote host via RPC interface (e.g.,
@@ -35,9 +35,9 @@
</para>
<para>
When the SIP router process is stopped at a breakpoint, you can
- investigate the values of any pseudo-varaibles. Note that some of
- pseudo-variables may produce memory leak, that is planned to fix in the
- future (here falls pseudo-variables with dynamic name such as htable,
+ investigate the values of any pseudo-variables. Note that some of
+ pseudo-variables may produce memory leaks; a fix is planned in the
+ future (here fall pseudo-variables with dynamic name such as htable,
sqlops). References to SIP message, avps, headers, script and shared
variables are safe.
</para>
@@ -120,7 +120,7 @@ modparam("debugger", "breakpoint", 1)
<section>
<title><varname>log_level</varname> (int)</title>
<para>
- What log level to be used to print module specific messages.
+ What log level is to be used to print module-specific messages.
</para>
<para>
<emphasis>
@@ -140,7 +140,7 @@ modparam("debugger", "log_level", 1)
<section>
<title><varname>log_facility</varname> (str)</title>
<para>
- What log facility to be used to print module specific messages.
+ What log facility is to be used to print module-specific messages.
</para>
<para>
<emphasis>
@@ -160,7 +160,7 @@ modparam("debugger", "log_facility", "LOG_DAEMON")
<section>
<title><varname>log_prefix</varname> (str)</title>
<para>
- String to print before any module specific messages.
+ String to print before any module-specific messages.
</para>
<para>
<emphasis>
@@ -181,11 +181,11 @@ modparam("debugger", "log_prefix", "from-debugger-with-love:")
<title><varname>step_usleep</varname> (int)</title>
<para>
Microseconds to sleep before checking for new commands when
- waiting at breakpoint
+ waiting at breakpoint.
</para>
<para>
<emphasis>
- Default value is <quote>100000</quote> (that is 0.1sec).
+ Default value is <quote>100000</quote> (that is 0.1 sec).
</emphasis>
</para>
<example>
@@ -203,7 +203,7 @@ modparam("debugger", "step_usleep", 500000)
<para>
How many sleeps of 'step_usleep' the RPC process performs when
waiting for a reply from worker process before responding to RPC.
- This avoids blocking RPC process for ever in case the worker
+ This avoids blocking RPC process forever in case the worker
process 'forgets' to write back a reply.
</para>
<para>
@@ -230,12 +230,13 @@ modparam("debugger", "step_loops", 100)
<function moreinfo="none">dbg_breakpoint(mode)</function>
</title>
<para>
- Anchor a breakpoint at that line in config. Mode specifies
- whether the breakpoint is enabled (1) or disabled (0) at startup.
+ Anchor a breakpoint at the current line of the config (the one
+ on which this function is called). The 'mode' specifies whether
+ the breakpoint is enabled (1) or disabled (0) at startup.
</para>
<para>
Note that this version does not export this anchors to RPC for
- interactive debugging (temporary disabled).
+ interactive debugging (temporarily disabled).
</para>
<example>
<title><function>dbg_breakpoint</function> usage</title>
@@ -266,11 +267,11 @@ if($si=="10.0.0.10")
</para>
<para>Parameters:</para>
<itemizedlist>
- <listitem><para>_pid_ : pid for which to list the details. If it
- missing, then will print for all processes.</para></listitem>
+ <listitem><para>_pid_ : pid for which to list the details. If 'pid' is
+ omitted then will print for all processes.</para></listitem>
</itemizedlist>
<para>
- Examples for using with sercmd:
+ Examples of use with sercmd:
</para>
<programlisting format="linespecific">
dbg.ls
@@ -291,10 +292,10 @@ if($si=="10.0.0.10")
<para>Parameters:</para>
<itemizedlist>
<listitem><para>_cmd_ : inner command can be 'on' or 'off' to
- enable or disable the tracing for one or all processe.</para>
+ enable or disable tracing for one or all processes.</para>
</listitem>
- <listitem><para>_pid_ : pid for which to list the details. If it
- missing, then will print for all processes.</para>
+ <listitem><para>_pid_ : pid for which to list the details. If 'pid' is
+ omitted, then it will print details for all processes.</para>
</listitem>
</itemizedlist>
<para>
@@ -323,7 +324,8 @@ if($si=="10.0.0.10")
the list of available values.</para>
</listitem>
<listitem><para>_pid_ : pid for which to apply the inner command.
- If it is missing, then will be applied for all processes.</para>
+ If 'pid' is omitted, then the inner command will be applied
+ to all processes.</para>
</listitem>
<listitem><para>_params_ : extra params specific for each inner
command.</para>
@@ -393,7 +395,7 @@ if($si=="10.0.0.10")
</para>
<para>
Another typical usage is to do interactive debugging and run
- step-by-step each line in routing blocks of config file for a
+ each line of the route blocks of the config file step-by-step for a
particular SIP message.
</para>
<para>
@@ -460,7 +462,7 @@ sercmd> dbg.bp move 6402
...
</programlisting>
<para>
- Running config trace looks like:
+ Running the config trace looks like:
</para>
<programlisting format="linespecific">
...
@@ -501,11 +503,11 @@ sercmd> dbg.bp move 6402
...
</programlisting>
<para>
- Above example is for registration with default config for
+ The above example is for registration with default config for
version 3.1.0, without authentication. Listed fields are:
'c' - config file; 'l' - line; 'a' - internal action id;
'n' - name of executed action. 'ERROR' prefix is printed
- because these messages were sent to L_ERR log level.
+ because these messages were sent to the L_ERR log level.
</para>
</section>
Module: sip-router
Branch: master
Commit: fd2c02bb06d35dca81be2e5c40e4190c91c58603
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=fd2c02b…
Author: Alex Balashov <abalashov(a)evaristesys.com>
Committer: Alex Balashov <abalashov(a)evaristesys.com>
Date: Tue Oct 5 20:28:28 2010 -0400
Fixed typo in 'xhttp' module documentation.
---
modules/xhttp/README | 2 +-
modules/xhttp/doc/xhttp_admin.xml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/modules/xhttp/README b/modules/xhttp/README
index a44ee3c..ae772fd 100644
--- a/modules/xhttp/README
+++ b/modules/xhttp/README
@@ -91,7 +91,7 @@ Chapter 1. Admin Guide
3.1. url_skip (str)
- Regular expression to match the HTPP URL. If there is match, then event
+ Regular expression to match the HTTP URL. If there is match, then event
route is not executed.
Default value is null (don't skip).
diff --git a/modules/xhttp/doc/xhttp_admin.xml b/modules/xhttp/doc/xhttp_admin.xml
index 9ca9af8..7128d34 100644
--- a/modules/xhttp/doc/xhttp_admin.xml
+++ b/modules/xhttp/doc/xhttp_admin.xml
@@ -63,7 +63,7 @@
<section>
<title><varname>url_skip</varname> (str)</title>
<para>
- Regular expression to match the HTPP URL. If there is match,
+ Regular expression to match the HTTP URL. If there is match,
then event route is not executed.
</para>
<para>
when i build debian package from master, i get from dpkg-shlibdeps these
warnings. are they something to worry about?
-- juha
dpkg-shlibdeps: warning: debian/sip-proxy/usr/lib/sip-proxy/libsrdb1.so.1.0 contains an unresolvable reference to symbol core_cfg: it's probably a plugin.
dpkg-shlibdeps: warning: 9 other similar warnings have been skipped (use -v to see them all).
dpkg-shlibdeps: warning: debian/sip-proxy/usr/lib/sip-proxy/libkmi.so.1.0 contains an unresolvable reference to symbol core_cfg: it's probably a plugin.
dpkg-shlibdeps: warning: 11 other similar warnings have been skipped (use -v to see them all).
dpkg-shlibdeps: warning: debian/sip-proxy/usr/lib/sip-proxy/libsrdb2.so.1.0 contains an unresolvable reference to symbol core_cfg: it's probably a plugin.
dpkg-shlibdeps: warning: 10 other similar warnings have been skipped (use -v to see them all).
dpkg-shlibdeps: warning: debian/sip-proxy/usr/lib/sip-proxy/libkcore.so.1.0 contains an unresolvable reference to symbol get_sock_info_list: it's probably a plugin.
dpkg-shlibdeps: warning: 29 other similar warnings have been skipped (use -v to see them all).
dpkg-shlibdeps: warning: dependency on libz.so.1 could be avoided if "debian/sip-proxy/usr/lib/sip-proxy/modules/db_mysql.so" were not uselessly linked against it (they use none of its symbols).
dpkg-shlibdeps: warning: dependency on libncurses.so.5 could be avoided if "debian/sip-proxy/usr/sbin/sip-proxy_ctl" were not uselessly linked against it (they use none of its symbols).
Module: sip-router
Branch: 3.1
Commit: 0c5d4312e2859299caa93ac7ab4c9034d27dcd18
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0c5d431…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: Tue Oct 5 21:51:15 2010 +0200
ChangeLog: refurbished for version 3.1.0
- built from git log since Jan 11, 2010
- no longer includes changes for old releases since it is too big
---
ChangeLog |22111 ++++++++++++++++++++++++++++++++-----------------------------
1 files changed, 11674 insertions(+), 10437 deletions(-)
Diff: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commitdiff;h=0c5…