2
0
Эх сурвалжийг харах

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

Alex Balashov 15 жил өмнө
parent
commit
242054fc4c

+ 10 - 9
modules/blst/README

@@ -4,7 +4,7 @@ Andrei Pelinescu-Onciul
 
 
    iptelorg GmbH
    iptelorg GmbH
 
 
-   Copyright © 2007 iptelorg GmbH
+   Copyright © 2007 iptelorg GmbH
    Revision History
    Revision History
    Revision $Revision$ $Date$
    Revision $Revision$ $Date$
      __________________________________________________________________
      __________________________________________________________________
@@ -50,8 +50,8 @@ else
    Adds the source of the current message to the blacklist for the time
    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
    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
    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.
    instead.
 
 
    Example 2. blst_add_retry_after usage
    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()
 1.2.5.  blst_set_ignore() blst_set_ignore(flags) blst_rpl_set_ignore()
 blst_rpl_set_ignore(flags)
 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_set_ignore(..) works for forwarding the current message and
    blst_rpl_set_ignore(...) works for local replies to the current
    blst_rpl_set_ignore(...) works for local replies to the current
    message.
    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).
      * 0x02 - generic send error (send denied/ failed).
      * 0x04 - connect failed (TCP, TLS or SCTP).
      * 0x04 - connect failed (TCP, TLS or SCTP).
      * 0x08 - ICMP error (not currently used).
      * 0x08 - ICMP error (not currently used).

+ 7 - 6
modules/blst/doc/functions.xml

@@ -48,10 +48,10 @@ else
 		header.
 		header.
 		If the <emphasis>Retry-After</emphasis> header is missing, it will 
 		If the <emphasis>Retry-After</emphasis> header is missing, it will 
 		fail (returns false).
 		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 
 		<varname>min</varname>, then <varname>min</varname> seconds will be 
 		used instead.
 		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 
 		<varname>max</varname>, then <varname>max</varname> seconds will be 
 		used instead.
 		used instead.
 	</para>
 	</para>
@@ -117,7 +117,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 	</title>
 	</title>
 	<para>
 	<para>
 		Set errors that will not be taken into account when deciding
 		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.
 		or a local reply to the current message.
 	</para>
 	</para>
 	<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.
 		works for local replies to the current message.
 	</para>
 	</para>
 	<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>
 	<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>
 		<itemizedlist>
 			<listitem>
 			<listitem>
 				<emphasis>0x02</emphasis> - generic send error (send denied/
 				<emphasis>0x02</emphasis> - generic send error (send denied/