[sr-dev] git:master: modules_k: siputils Improved documentation of ring_timeout parameter

[Marius Zbihlei]

Module: sip-router
Branch: master
Commit: 5783579581b4f04afd8ea341c7519becabece1a9
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5783579581b4f04afd8ea341c7519becabece1a9

Author: Marius Zbihlei <marius.zbihlei at 1and1.ro>
Committer: Marius Zbihlei <marius.zbihlei at 1and1.ro>
Date:   Thu Jan 28 12:10:24 2010 +0200

modules_k:siputils Improved documentation of ring_timeout parameter

---

 modules_k/siputils/README                 |    5 +++--
 modules_k/siputils/doc/siputils_admin.xml |    4 ++--
 modules_k/siputils/ring.c                 |    2 +-
 modules_k/siputils/siputils.c             |    2 +-
 4 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/modules_k/siputils/README b/modules_k/siputils/README
index 80381c5..9078784 100644
--- a/modules_k/siputils/README
+++ b/modules_k/siputils/README
@@ -187,9 +187,10 @@ Chapter 1. Admin Guide
 3.1. ring_timeout (int)
 
    Timeout value in seconds, define how long the call-id is stored in the
-   internal list. A reasonable value is "30".
+   internal list kept for replacing 183 messages with 180. A reasonable
+   value is "30".
 
-   Default value is "0".
+   Default value is "0". This means functionality is disabled.
 
    Example 1.1. Set ring_timeout parameter
 ...
diff --git a/modules_k/siputils/doc/siputils_admin.xml b/modules_k/siputils/doc/siputils_admin.xml
index 982dd84..84f546e 100644
--- a/modules_k/siputils/doc/siputils_admin.xml
+++ b/modules_k/siputils/doc/siputils_admin.xml
@@ -75,12 +75,12 @@
 		<section>
 			<title><varname>ring_timeout</varname> (int)</title>
 			<para>
-			Timeout value in seconds, define how long the call-id is stored in the internal list.
+			Timeout value in seconds, define how long the call-id is stored in the internal list kept for replacing 183 messages  with 180.
 			A reasonable value is <quote>30</quote>.
 			</para>
 			<para>
 			<emphasis>
-				Default value is <quote>0</quote>.
+				Default value is <quote>0</quote>. This means functionality is disabled.
 			</emphasis>
 			</para>
 			<example>
diff --git a/modules_k/siputils/ring.c b/modules_k/siputils/ring.c
index 4d59a02..f895572 100644
--- a/modules_k/siputils/ring.c
+++ b/modules_k/siputils/ring.c
@@ -237,7 +237,7 @@ static int contains(str callid)
 
 
 /*!
- * \brief Convert a 180 to a 180 message.
+ * \brief Convert a 183  to a 180 message.
  * \param msg SIP message
  */
 static int conv183(struct sip_msg *msg)
diff --git a/modules_k/siputils/siputils.c b/modules_k/siputils/siputils.c
index a018462..461dd30 100644
--- a/modules_k/siputils/siputils.c
+++ b/modules_k/siputils/siputils.c
@@ -120,7 +120,7 @@ static param_export_t params[] = {
 	{"options_accept_encoding", STR_PARAM, &opt_accept_enc.s},
 	{"options_accept_language", STR_PARAM, &opt_accept_lang.s},
 	{"options_support",         STR_PARAM, &opt_supported.s},
-	{"contact_flds_separator",  STR_PARAM,&contact_flds_separator},
+	{"contact_flds_separator",  STR_PARAM, &contact_flds_separator},
 	{0, 0, 0}
 };