You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by mm...@apache.org on 2010/02/15 18:48:45 UTC
svn commit: r910278 - in /spamassassin/trunk: ./ lib/ lib/Mail/SpamAssassin/
lib/Mail/SpamAssassin/Conf/ lib/Mail/SpamAssassin/Message/
lib/Mail/SpamAssassin/Plugin/ lib/Mail/SpamAssassin/Util/
rulesrc/sandbox/dos/ spamc/ spamd-apache2/lib/Mail/SpamAss...
Author: mmartinec
Date: Mon Feb 15 17:47:58 2010
New Revision: 910278
URL: http://svn.apache.org/viewvc?rev=910278&view=rev
Log:
Bug 6072: pod warnings
Bug 6249: several syntax warnings in POD documentation
Modified:
spamassassin/trunk/lib/Mail/SpamAssassin/AICache.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Conf/LDAP.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Conf/SQL.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Message/Metadata.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Message/Node.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ASN.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/BodyRuleBaseExtractor.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DKIM.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Shortcircuit.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/VBounce.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Timeout.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Util/DependencyInfo.pm
spamassassin/trunk/lib/Mail/SpamAssassin/Util/RegistrarBoundaries.pm
spamassassin/trunk/lib/spamassassin-run.pod
spamassassin/trunk/rulesrc/sandbox/dos/SIQ.pm
spamassassin/trunk/sa-compile.raw
spamassassin/trunk/sa-update.raw
spamassassin/trunk/spamc/spamc.pod
spamassassin/trunk/spamd-apache2/lib/Mail/SpamAssassin/Spamd.pm
spamassassin/trunk/t/data/taintcheckplugin.pm
spamassassin/trunk/t/data/testplugin.pm
spamassassin/trunk/t/data/testplugin2.pm
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/AICache.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/AICache.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/AICache.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/AICache.pm Mon Feb 15 17:47:58 2010
@@ -49,6 +49,8 @@
Generates a new cache object.
+=back
+
=cut
sub new {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf.pm Mon Feb 15 17:47:58 2010
@@ -277,6 +277,8 @@
}
});
+=back
+
=head2 WHITELIST AND BLACKLIST OPTIONS
=over 4
@@ -1677,8 +1679,6 @@
}
});
-=over 4
-
=item lock_method type
Select the file-locking method used to protect database files on-disk. By
@@ -3414,6 +3414,8 @@
(Unlike the C<compact> option, the long option shows declassification
distances that are greater than 9.)
+=back
+
=cut
return \@cmds;
@@ -3999,8 +4001,6 @@
1;
__END__
-=back
-
=head1 LOCALI[SZ]ATION
A line starting with the text C<lang xx> will only be interpreted
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf/LDAP.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Conf/LDAP.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf/LDAP.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf/LDAP.pm Mon Feb 15 17:47:58 2010
@@ -87,6 +87,8 @@
Read configuration paramaters from LDAP server and parse scores from it.
+=back
+
=cut
sub load {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf/Parser.pm Mon Feb 15 17:47:58 2010
@@ -123,10 +123,6 @@
=back
-=head1 METHODS
-
-=over 4
-
=cut
package Mail::SpamAssassin::Conf::Parser;
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Conf/SQL.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Conf/SQL.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Conf/SQL.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Conf/SQL.pm Mon Feb 15 17:47:58 2010
@@ -85,6 +85,8 @@
Read configuration paramaters from SQL database and parse scores from it.
+=back
+
=cut
sub load {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Message/Metadata.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Message/Metadata.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Message/Metadata.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Message/Metadata.pm Mon Feb 15 17:47:58 2010
@@ -60,6 +60,8 @@
=item new()
+=back
+
=cut
sub new {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Message/Node.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Message/Node.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Message/Node.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Message/Node.pm Mon Feb 15 17:47:58 2010
@@ -669,6 +669,8 @@
returned with each header entry in a different element. In a scalar
context, the headers are returned in a single scalar.
+=back
+
=cut
# build it and it will not bomb
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm Mon Feb 15 17:47:58 2010
@@ -896,8 +896,6 @@
Called when the C<Mail::SpamAssassin> object is destroyed.
-=back
-
=cut
sub finish {
@@ -1005,6 +1003,8 @@
=back
+=back
+
=head1 HELPER APIS
These methods provide an API for plugins to register themselves
@@ -1079,6 +1079,8 @@
chain for the current callback. Frequently used when parsing configuration
settings using C<parse_config()>.
+=back
+
=cut
sub inhibit_further_callbacks {
@@ -1091,6 +1093,8 @@
=head1 LOGGING
+=over 4
+
=item Mail::SpamAssassin::Plugin::dbg($message)
Output a debugging message C<$message>, if the SpamAssassin object is running
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ASN.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ASN.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ASN.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/ASN.pm Mon Feb 15 17:47:58 2010
@@ -141,6 +141,8 @@
asn_lookup in1tag.example.net _ASNDATA_ _ASNDATA_
+=back
+
=cut
push (@cmds, {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/BodyRuleBaseExtractor.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/BodyRuleBaseExtractor.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/BodyRuleBaseExtractor.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/BodyRuleBaseExtractor.pm Mon Feb 15 17:47:58 2010
@@ -1038,11 +1038,15 @@
close CACHE or die "error closing $cachefile: $!";
}
+=over 4
+
=item my ($cleanregexp) = fixup_re($regexp);
Converts encoded characters in a regular expression pattern into their
equivalent characters
+=back
+
=cut
sub fixup_re {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DKIM.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DKIM.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DKIM.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/DKIM.pm Mon Feb 15 17:47:58 2010
@@ -31,6 +31,7 @@
Taking into account signatures from specified signing domains only:
(quotes may be omitted on domain names consisting only of letters, digits,
dots, and minus characters)
+
full DKIM_SIGNED_MY1 eval:check_dkim_signed('dom1','dom2',...)
full DKIM_VALID_MY1 eval:check_dkim_valid('dom1','dom2',...)
full DKIM_VALID_AU_MY1 eval:check_dkim_valid_author_sig('d1','d2',...)
@@ -38,6 +39,7 @@
full __DKIM_DEPENDABLE eval:check_dkim_dependable()
Author Domain Signing Practices (ADSP) from any author domains:
+
header DKIM_ADSP_NXDOMAIN eval:check_dkim_adsp('N')
header DKIM_ADSP_ALL eval:check_dkim_adsp('A')
header DKIM_ADSP_DISCARD eval:check_dkim_adsp('D')
@@ -46,6 +48,7 @@
header DKIM_ADSP_CUSTOM_HIGH eval:check_dkim_adsp('3')
Author Domain Signing Practices (ADSP) from specified author domains only:
+
header DKIM_ADSP_MY1 eval:check_dkim_adsp('*','dom1','dom2',...)
describe DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid
@@ -61,6 +64,7 @@
describe DKIM_ADSP_CUSTOM_HIGH adsp_override is CUSTOM_HIGH, no valid author domain signature
For compatibility with pre-3.3.0 versions, the following are synonyms:
+
OLD: eval:check_dkim_verified = NEW: eval:check_dkim_valid
OLD: eval:check_dkim_signall = NEW: eval:check_dkim_adsp('A')
OLD: eval:check_dkim_signsome = NEW: redundant, semantically always true
@@ -418,6 +422,8 @@
How many seconds to wait for a DKIM query to complete, before
scanning continues without the DKIM result.
+=back
+
=cut
push (@cmds, {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Shortcircuit.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Shortcircuit.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Shortcircuit.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/Shortcircuit.pm Mon Feb 15 17:47:58 2010
@@ -75,6 +75,8 @@
The following configuration settings are used to control shortcircuiting:
+=over 4
+
=item shortcircuit SYMBOLIC_TEST_NAME {ham|spam|on|off}
Shortcircuiting a test will force all other pending rules to be skipped, if
@@ -218,6 +220,8 @@
$conf->{parser}->register_commands(\@cmds);
}
+=back
+
=head1 TAGS
The following tags are added to the set available for use in reports, headers
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/VBounce.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/VBounce.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/VBounce.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/VBounce.pm Mon Feb 15 17:47:58 2010
@@ -78,6 +78,7 @@
Multiple addresses per line, separated by spaces, is OK. Multiple
C<whitelist_bounce_relays> lines are also OK.
+=back
=cut
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Timeout.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Timeout.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Timeout.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Timeout.pm Mon Feb 15 17:47:58 2010
@@ -310,6 +310,8 @@
to be restored to its original setting (useful after our alarm setting was
clobbered by some underlying module).
+=back
+
=cut
sub reset {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Util/DependencyInfo.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Util/DependencyInfo.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Util/DependencyInfo.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Util/DependencyInfo.pm Mon Feb 15 17:47:58 2010
@@ -218,11 +218,15 @@
###########################################################################
+=over 4
+
=item $f->debug_diagnostics ()
Output some diagnostic information, useful for debugging SpamAssassin
problems.
+=back
+
=cut
sub debug_diagnostics {
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Util/RegistrarBoundaries.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Util/RegistrarBoundaries.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Util/RegistrarBoundaries.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Util/RegistrarBoundaries.pm Mon Feb 15 17:47:58 2010
@@ -268,6 +268,8 @@
###########################################################################
+=over 4
+
=item ($hostname, $domain) = split_domain ($fqdn)
Cut a fully-qualified hostname into the hostname part and the domain
@@ -370,6 +372,8 @@
(a) does not contain whitespace, (b) contains at least one dot, and (c)
uses a valid TLD or ccTLD.
+=back
+
=cut
sub is_domain_valid {
Modified: spamassassin/trunk/lib/spamassassin-run.pod
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/spamassassin-run.pod?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/lib/spamassassin-run.pod (original)
+++ spamassassin/trunk/lib/spamassassin-run.pod Mon Feb 15 17:47:58 2010
@@ -1,5 +1,3 @@
-=cut
-
<@LICENSE>
Copyright 2004 Apache Software Foundation
@@ -278,7 +276,7 @@
For more information about which areas (also known as channels) are available,
please see the documentation at:
- C<http://wiki.apache.org/spamassassin/DebugChannels>
+ L<http://wiki.apache.org/spamassassin/DebugChannels>
=item B<-x>, B<--nocreate-prefs>
Modified: spamassassin/trunk/rulesrc/sandbox/dos/SIQ.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/rulesrc/sandbox/dos/SIQ.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/rulesrc/sandbox/dos/SIQ.pm (original)
+++ spamassassin/trunk/rulesrc/sandbox/dos/SIQ.pm Mon Feb 15 17:47:58 2010
@@ -209,6 +209,8 @@
<b>Note: Currently only file-glob style wildcards are supported. CIDR
notation, nor any other format, is <b> NOT supported.
+=back
+
=cut
push (@cmds, {
@@ -236,8 +238,6 @@
There are no privileged settings provided.
-=over 4
-
=head1 ADMINISTRATOR SETTINGS
These settings differ from the ones above, in that they are considered 'more
@@ -648,6 +648,8 @@
yet be present if this rule's priority is less than (higher) than the above
eval tests.
+=back
+
=cut
sub _parse_eval_call {
Modified: spamassassin/trunk/sa-compile.raw
URL: http://svn.apache.org/viewvc/spamassassin/trunk/sa-compile.raw?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/sa-compile.raw (original)
+++ spamassassin/trunk/sa-compile.raw Mon Feb 15 17:47:58 2010
@@ -656,8 +656,6 @@
##############################################################################
-=cut
-
=head1 NAME
sa-compile - compile SpamAssassin ruleset into native code
Modified: spamassassin/trunk/sa-update.raw
URL: http://svn.apache.org/viewvc/spamassassin/trunk/sa-update.raw?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/sa-update.raw (original)
+++ spamassassin/trunk/sa-update.raw Mon Feb 15 17:47:58 2010
@@ -1410,8 +1410,6 @@
##############################################################################
-=cut
-
=head1 NAME
sa-update - automate SpamAssassin rule updates
Modified: spamassassin/trunk/spamc/spamc.pod
URL: http://svn.apache.org/viewvc/spamassassin/trunk/spamc/spamc.pod?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/spamc/spamc.pod (original)
+++ spamassassin/trunk/spamc/spamc.pod Mon Feb 15 17:47:58 2010
@@ -1,5 +1,3 @@
-=cut
-
<@LICENSE>
Copyright 2004 Apache Software Foundation
Modified: spamassassin/trunk/spamd-apache2/lib/Mail/SpamAssassin/Spamd.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/spamd-apache2/lib/Mail/SpamAssassin/Spamd.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/spamd-apache2/lib/Mail/SpamAssassin/Spamd.pm (original)
+++ spamassassin/trunk/spamd-apache2/lib/Mail/SpamAssassin/Spamd.pm Mon Feb 15 17:47:58 2010
@@ -604,8 +604,6 @@
=over
-=cut
-
=item C<_remote_host()>
=item C<_remote_ip()>
@@ -641,6 +639,8 @@
XXX
+=back
+
=cut
Modified: spamassassin/trunk/t/data/taintcheckplugin.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/t/data/taintcheckplugin.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/t/data/taintcheckplugin.pm (original)
+++ spamassassin/trunk/t/data/taintcheckplugin.pm Mon Feb 15 17:47:58 2010
@@ -1,4 +1,4 @@
-=head1
+=head1 taintcheckplugin.pm
To try this out, write these lines to /etc/mail/spamassassin/plugintest.cf:
Modified: spamassassin/trunk/t/data/testplugin.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/t/data/testplugin.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/t/data/testplugin.pm (original)
+++ spamassassin/trunk/t/data/testplugin.pm Mon Feb 15 17:47:58 2010
@@ -1,4 +1,4 @@
-=head1
+=head1 testplugin.pm
To try this out, write these lines to /etc/mail/spamassassin/plugintest.cf:
Modified: spamassassin/trunk/t/data/testplugin2.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/t/data/testplugin2.pm?rev=910278&r1=910277&r2=910278&view=diff
==============================================================================
--- spamassassin/trunk/t/data/testplugin2.pm (original)
+++ spamassassin/trunk/t/data/testplugin2.pm Mon Feb 15 17:47:58 2010
@@ -1,4 +1,4 @@
-=head1
+=head1 testplugin2.pm
To try this out, write these lines to /etc/mail/spamassassin/plugintest.cf: