[sr-dev] git:master: Cleaned up some grammatical errors and added some clarification to

Alex Balashov abalashov at evaristesys.com
Wed Oct 6 08:22:48 CEST 2010


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

Author: Alex Balashov <abalashov at evaristesys.com>
Committer: Alex Balashov <abalashov at evaristesys.com>
Date:   Wed Oct  6 02:22:08 2010 -0400

Cleaned up some grammatical errors and added some clarification to
blst module documentation.

---

 modules/blst/README            |   19 ++++++++++---------
 modules/blst/doc/functions.xml |   13 +++++++------
 2 files changed, 17 insertions(+), 15 deletions(-)

diff --git a/modules/blst/README b/modules/blst/README
index 44b966e..74260de 100644
--- a/modules/blst/README
+++ b/modules/blst/README
@@ -4,7 +4,7 @@ Andrei Pelinescu-Onciul
 
    iptelorg GmbH
 
-   Copyright © 2007 iptelorg GmbH
+   Copyright © 2007 iptelorg GmbH
    Revision History
    Revision $Revision$ $Date$
      __________________________________________________________________
@@ -50,8 +50,8 @@ else
    Adds the source of the current message to the blacklist for the time
    interval specified in the Retry-After header. If the Retry-After header
    is missing, it will fail (returns false). If the Retry-After value is
-   less then min, then min seconds will be used instead. If the
-   Retry-After value is greater then max, then max seconds will be used
+   less than min, then min seconds will be used instead. If the
+   Retry-After value is greater than max, then max seconds will be used
    instead.
 
    Example 2. blst_add_retry_after usage
@@ -89,18 +89,19 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 1.2.5.  blst_set_ignore() blst_set_ignore(flags) blst_rpl_set_ignore()
 blst_rpl_set_ignore(flags)
 
-   Set errors that will not be taken into account when deciding whether or
-   not to blacklist a destination for the current message or a local reply
-   to the current message.
+   Set errors that will not be taken into account when deciding whether to
+   blacklist a destination for the current message or a local reply to the
+   current message.
 
    blst_set_ignore(..) works for forwarding the current message and
    blst_rpl_set_ignore(...) works for local replies to the current
    message.
 
-   The variants with no parameters will ignore everything (equivalent with
-   passing 0xff).
+   The variants of these functions with no parameters will ignore
+   everything (equivalent to passing 0xff).
 
-   The following flags are defined:
+   The flags are stored internally as a bitmask, and are applied by
+   bitwise ANDing them together. The following flags are available:
      * 0x02 - generic send error (send denied/ failed).
      * 0x04 - connect failed (TCP, TLS or SCTP).
      * 0x08 - ICMP error (not currently used).
diff --git a/modules/blst/doc/functions.xml b/modules/blst/doc/functions.xml
index 86bd87b..3c80996 100644
--- a/modules/blst/doc/functions.xml
+++ b/modules/blst/doc/functions.xml
@@ -48,10 +48,10 @@ else
 		header.
 		If the <emphasis>Retry-After</emphasis> header is missing, it will 
 		fail (returns false).
-		If the <emphasis>Retry-After</emphasis> value is less then 
+		If the <emphasis>Retry-After</emphasis> value is less than 
 		<varname>min</varname>, then <varname>min</varname> seconds will be 
 		used instead.
-		If the <emphasis>Retry-After</emphasis> value is greater then 
+		If the <emphasis>Retry-After</emphasis> value is greater than
 		<varname>max</varname>, then <varname>max</varname> seconds will be 
 		used instead.
 	</para>
@@ -117,7 +117,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 	</title>
 	<para>
 		Set errors that will not be taken into account when deciding
-		whether or not to blacklist a destination for the current message
+		whether to blacklist a destination for the current message
 		or a local reply to the current message.
 	</para>
 	<para>
@@ -126,11 +126,12 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 		works for local replies to the current message.
 	</para>
 	<para>
-		The variants with no parameters will ignore everything (equivalent
-		with passing 0xff).
+		The variants of these functions with no parameters will ignore 
+		everything (equivalent to passing 0xff).
 	</para>
 	<para>
-		The following flags are defined:
+		The flags are stored internally as a bitmask, and are applied by
+		bitwise ANDing them together.  The following flags are available:
 		<itemizedlist>
 			<listitem>
 				<emphasis>0x02</emphasis> - generic send error (send denied/




More information about the sr-dev mailing list