svn commit: r896403 - in /spamassassin/trunk/lib/Mail/SpamAssassin: Conf.pm Conf/Parser.pm

[mm...@apache.org]

Author: mmartinec
Date: Wed Jan  6 11:37:32 2010
New Revision: 896403

URL: http://svn.apache.org/viewvc?rev=896403&view=rev
Log:
Bug 5895: a documentation change and a simplification

Modified:
    spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
    spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm

Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm?rev=896403&r1=896402&r2=896403&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm Wed Jan  6 11:37:32 2010
@@ -1201,33 +1201,33 @@
 
 =item originating_ip_headers header ...   (default: X-Yahoo-Post-IP X-Originating-IP X-Apparently-From X-SenderIP)
 
-Headers to parse originating IP addresses for. For example webmail servers
-usually record the client address in X-Originating-IP.
+A list of header field names from which an originating IP address can
+be obtained. For example, webmail servers may record a client IP address
+in X-Originating-IP.
 
 These IP addresses are virtually appended into the Received: chain, so they
 are used in RBL checks where appropriate.
 
-Currently the IP addresses are not added into X-Spam-Relays-* headers, but
-they may be in the future.
+Currently the IP addresses are not added into X-Spam-Relays-* header fields,
+but they may be in the future.
 
 =cut
 
   push (@cmds, {
     setting => 'originating_ip_headers',
+    default => [],
     code => sub {
       my ($self, $key, $value, $line) = @_;
       unless (defined $value && $value !~ /^$/) {
 	return $MISSING_REQUIRED_VALUE;
       }
-      foreach my $header (split (/\s+/, $value)) {
-        push(@{$self->{originating_ip_headers}}, $header);
-      }
+      push(@{$self->{originating_ip_headers}}, split(/\s+/, $value));
     }
   });
 
 =item clear_originating_ip_headers
 
-Empty the list of originating headers.
+Empty the list of 'originating IP address' header field names.
 
 =cut
 

Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm?rev=896403&r1=896402&r2=896403&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm Wed Jan  6 11:37:32 2010
@@ -60,7 +60,7 @@
            - $CONF_TYPE_NUMERIC: numeric value (float or int)
            - $CONF_TYPE_BOOL: boolean (0/no or 1/yes)
            - $CONF_TYPE_TEMPLATE: template, like "report"
-           - $CONF_TYPE_ADDRLIST: address list, like "whitelist_from"
+           - $CONF_TYPE_ADDRLIST: mail address list, like "whitelist_from"
            - $CONF_TYPE_HASH_KEY_VALUE: hash key/value pair,
              like "describe" or tflags