svn commit: r901258 - /spamassassin/trunk/build/announcements/3.3.0-release.txt

[kh...@apache.org]

Author: khopesh
Date: Wed Jan 20 16:25:02 2010
New Revision: 901258

URL: http://svn.apache.org/viewvc?rev=901258&view=rev
Log:
grammar, spelling, consistency, and phrasing edits, all minor.  since this is an IMPORTANT document, please double-check

Modified:
    spamassassin/trunk/build/announcements/3.3.0-release.txt

Modified: spamassassin/trunk/build/announcements/3.3.0-release.txt
URL: http://svn.apache.org/viewvc/spamassassin/trunk/build/announcements/3.3.0-release.txt?rev=901258&r1=901257&r2=901258&view=diff
==============================================================================
--- spamassassin/trunk/build/announcements/3.3.0-release.txt (original)
+++ spamassassin/trunk/build/announcements/3.3.0-release.txt Wed Jan 20 16:25:02 2010
@@ -13,7 +13,7 @@
 accumulated in a year and a half of development since the 3.2.5 release.
 Apart from some new or changed dependencies on perl modules, this version
 is compatible to large extent with existing installations, so the upgrade
-is not expected to be problematic (and neither downgrading, if need arises).
+is not expected to be problematic (neither is downgrading, if need arises).
 Please consult the list of known incompatibilities below before upgrading.
 
 
@@ -64,35 +64,34 @@
 COMPATIBILITY WITH 3.2.5
 
 - rules are no longer distributed with the package, but installed by
-  sa-update - either automatically fetched from the network (preferably),
+  sa-update - either automatically fetched from the network (preferably)
   or from a tar archive, which is available for downloading separately
   (see below, section INSTALLING RULES);
 
 - CPAN module requirements:
-  - minimum required version of ExtUtils::MakeMaker is 6.17
+  - minimum required version of ExtUtils::MakeMaker is 6.17;
   - modules now required: Time::HiRes, NetAddr::IP (4.000 or later),
-    Archive::Tar (1.23 or later), IO::Zlib
+    Archive::Tar (1.23 or later), IO::Zlib;
   - minimal version of Mail::DKIM is 0.31 (preferred: 0.37 or later);
     expect some tests in t/dkim2.t to fail with versions older than 0.36_5;
-  - no longer used: Mail::DomainKeys, Mail::SPF::Query
-  - if module Digest::SHA is not available, a module Digest::SHA1
-    will be used, but at least one of them must be installed;
-    a DKIM plugin requires Digest::SHA (the older Digest::SHA1 does not
-    support sha256 hashes), so in practice the Digest::SHA is required
+  - no longer used: Mail::DomainKeys, Mail::SPF::Query;
+  - either Digest::SHA or the older Digest::SHA1 is required, though
+    note that the DKIM plugin requires Digest::SHA for sha256 hashes
+    and Razor agents still need Digest::SHA1;
 
-- if keeping AWL database in SQL, the field awl.ip must be extended to
+- if keeping the AWL database in SQL, the field awl.ip must be extended to
   40 characters. The change is necessary to allow AWL to keep track of IPv6
   addresses which may appear in a mail header even on non-IPv6 -enabled host.
   While at it, consider also adding a field 'signedby' to the SQL table 'awl'
   (and adding 'auto_whitelist_distinguish_signed 1' to local.cf);
-  See sql/README.awl for details. The change need not be undone even if
+  see sql/README.awl for details. The change need not be undone even if
   downgrading back to 3.2.* for some reason;
 
 - fixing a protocol implementation error regarding a PING command required
   bumping up the SPAMC protocol version to 1.5.  Spamd retains compatibility
   with older spamc clients. Combining new spamc clients with pre-3.3 versions
   of a spamd daemon is not supported (but happens to work, except for the
-  PING and SKIP commands).
+  PING and SKIP commands);
 
 - if using one of the plugins (FreeMail, PhishTag, Reuse) which were
   previously not part of the official package, please retire your local copy
@@ -103,11 +102,11 @@
     loadplugin Mail::SpamAssassin::Plugin::AWL
 
 - it may be worth mentioning that a rule DKIM_VERIFIED has been renamed
-  to DKIM_VALID, to match its semantics;
+  to DKIM_VALID to match its semantics;
 
 - the DKIM plugin is now enabled by default for new installs, if the perl
-  module Mail::DKIM is installed.  However, SpamAssassin installation will
-  not overwrite existing .pre configuration files, so to use DKIM when
+  module Mail::DKIM is installed.  However, installation of SpamAssassin
+  will not overwrite existing .pre configuration files, so to use DKIM when
   upgrading from a previous release that did not use DKIM, a directive:
 
     loadplugin Mail::SpamAssassin::Plugin::DKIM
@@ -117,9 +116,9 @@
 
 - due to changes in some internal data structures (like Bug 6185, 6254),
   some third-party plugins may need to be updated. One such example is
-  the ClamAVPlugin plugin - please find a fresh version on its wiki page.
-  The updated ClamAVPlugin plugin can be used with both 3.2.5 as well as
-  with SpamAssassin 3.3.0;
+  the ClamAVPlugin plugin - please find a fresh version, which can be used
+  with both SpamAssassin versions 3.2.5 and 3.3.0, on its wiki page at
+  http://wiki.apache.org/spamassassin/ClamAVPlugin
 
 - versions of amavisd-new between 2.5.2 and 2.6.1 (inclusive) are incompatible
   with SpamAssassin 3.3; please upgrade amavisd to 2.6.2 or later, or apply
@@ -167,7 +166,7 @@
   supports multiple signatures, ADSP support with overrides) - (see below);
 
 - added 'if can(Class::method)' conditional statement, allowing configuration
-  settings to be conditionalised on plugin capabilities without requiring
+  settings to be conditional on plugin capabilities without requiring
   new version releases to do so;
 
 - added a --verbose option to the sa-update utility to show updated channels;
@@ -215,20 +214,20 @@
 WORKAROUNDS TO PERL BUGS AND LIMITATIONS
 
 - modified the Check.pm plugin to produce smaller chunks of source code
-  from rules (60 kB) to avoid Perl compiler crashing on exceeding stack size
+  from rules (60 kB) to avoid Perl compiler crashing on exceeding stack size;
 
 - localized global variables $1, $2, etc at several places, avoiding taint
-  issue from propagating
+  issue from propagating;
 
 - avoided Perl I/O bug by replacing line-by-line reading with read() where
   suitable, or played down the EBADF status in other places and only report
   it as a dbg instead of a die - while also providing a little speedup
-  (10 .. 25 %) on reading a message
+  (10 .. 25 %) on reading a message;
 
 - provided a new sub Message::split_into_array_of_short_lines to split
   a text into array of paragraph chunks of sizes between 1 kB and 2 kB,
   giving less opportunity to runaway regular expressions in rules;
-  fixes bugs: 5717, 5644, 5795, 5486, 5801, 5041
+  fixes bugs: 5717, 5644, 5795, 5486, 5801, 5041;
 
 
 MEMORY FOOTPRINT
@@ -286,17 +285,17 @@
 - added -n / --connect-timeout switch to spamc, allowing separate
   connection timeout from communication timeout;
 
-- added --filter-retries and --filter-retry-sleep
+- added --filter-retries and --filter-retry-sleep;
 
 - increased allowed line length in spamc.conf files to 8 KiB and report
-  an error when the limit is exceeded
+  an error when the limit is exceeded;
 
-- spamc would not time out connections to a hung spamd, fixed
+- fixed issue where spamc would not time out connections to a hung spamd;
 
 - spamc client library leaked the zlib compression buffer if compression
-  is used
+  is used;
 
-- spamc long option '--dest' was broken
+- spamc long option '--dest' was broken;
 
 
 SPAMD
@@ -308,7 +307,7 @@
 - additional tempfile cleanup in kill_handler;
 
 - added SPAMD_LOCALHOST option to "make test" to allow specifying
-  non-127.0.0.1 IP address for use in FreeBSD jail
+  non-127.0.0.1 IP address for use in FreeBSD jail;
 
 
 API
@@ -343,8 +342,8 @@
 
 - rules are no longer distributed with the package;
 
-- new scores have been generated by a GA algorithm and then manually tweaked,
-  based on cleaned datasets supplied by a dozen of volunteers;
+- new scores were generated by a genetic algorithm (GA) and then manually
+  tweaked based on cleaned datasets supplied by a dozen volunteers;
 
 - dropped redundant rules or rules causing too many false positives;
 
@@ -360,7 +359,7 @@
   __THEBAT_MUA, __ANY_OUTLOOK_MUA, RP_MATCHES_RCVD, one-word X-Mailer,
   advance_fee update, tweak SPAN rules, tweak skype and misquoted-HTML rules,
   added some new HTML obfuscation and Google feedproxy URI rules, 
-  tweak reevolved advance fee second-order metarules,
+  tweak revolved advance fee second-order metarules,
   added a test rule for postmaster+abuse missing, FROM_MISSPACED, 
   fix FROM_CONTAINS_TAB, added Facebook redirector pattern,
   avoided ISO-2022-JP FPs on TVD_SPACE_RATIO, GAPPY_SUBJECT, PLING_QUERY
@@ -390,13 +389,13 @@
 
 PLUGINS
 
-- new plugins: FreeMail, PhishTag, Reuse
+- new plugins: FreeMail, PhishTag, Reuse;
   
-- now enabled by default: DKIM
+- now enabled by default: DKIM;
 
-- now disabled by default: AWL
+- now disabled by default: AWL;
 
-- retired plugin: DomainKeys
+- retired plugin: DomainKeys;
 
 
 AWL PLUGIN
@@ -412,7 +411,7 @@
 
 - AutoWhitelist.pm: allowed storing a canonicalized IPv6 address, cropped
   to a configurable network mask (previously causing SQL server errors:
-  'value too long')
+  'value too long');
 
 - let AWL with SQL keep separate records for DKIM-signed and unsigned mail
   (when auto_whitelist_distinguish_signed configuration option is true,
@@ -437,10 +436,10 @@
 
 DKIM PLUGIN
 
-- the DKIM plugin is now enabled by default for new installs, if the perl
-  module Mail::DKIM is installed.  However, SpamAssassin installation will
+- the DKIM plugin is now enabled by default for new installs if the perl
+  module Mail::DKIM is installed.  However, installing SpamAssassin will
   not overwrite existing .pre configuration files, so to use DKIM when
-  upgrading from a previous release that did not use DKIM, a directive:
+  upgrading from a previous release that did not use DKIM, the directive:
 
     loadplugin Mail::SpamAssassin::Plugin::DKIM
 
@@ -543,7 +542,7 @@
 
 - 'pyzor_options' in Plugin/Pyzor.pm was not untainted;
 
-- URIDetail plugin was not taint safe, fixed;
+- made the URIDetail plugin taint safe;
 
 - fixed parsing of multi-line Received header fields for
   BOUNCE_MESSAGE/VBOUNCE_MESSAGE et al;
@@ -552,12 +551,12 @@
   file or from vpopmail utilities, avoid implicit untainting; report error
   if user preferences file exists but cannot be accessed;
 
-- avoid using raw data from DNS as a regexp in Plugin/ASN.pm;
+- avoided using raw data from DNS as a regexp in Plugin/ASN.pm;
 
 - ensured the dbg() and info() calls always return the same value (true)
   regardless of log level;
 
-- suppress logging of $& when its value is not available (i.e. when
+- suppressed logging of $& when its value is not available (i.e. when
   no regexp has been evaluated during rule evaluation);
 
 - Exporter never really worked in SA, was not enclosed in BEGIN {};
@@ -646,30 +645,29 @@
 - exposed existing function 'received_within_months' as an eval function
   in Plugin/HeaderEval.pm;
 
-- use /var/lock/subsys/spamd instead of /var/lock/subsys/spamassassin for
-  rc script, so that 'service spamd status' will work;
+- moved rc script to /var/lock/subsys/spamd instead of
+  /var/lock/subsys/spamassassin so 'service spamd status' will work;
 
-- re-download MIRRRORED.BY files at least once a week, or if
+- added feature to re-download MIRRRORED.BY files at least once a week, or if
   'sa-update --refreshmirrors' switch is used;
 
 - input delimiter $/ can be corrupted by a plugin, localize $/ and $\ before
   calling a plugin;
 
-- takes almost a minute to start spamd on a slow machine, bumped up the
-  retry counter to 180 seconds;
+- bumped the retry counter to 180 seconds for starting spamd on slow machines;
 
 - resolved Bug 5325: syslog severity level in spamc/libspamc.c for max
   message size (changed LOG_ERR into LOG_NOTICE for the message:
   "skipped message, greater than max message size");
 
-- avoid taint warnings if hostname is returned as '(none)';
+- added checker to avoid taint warnings if hostname is returned as '(none)';
 
-- produce an error message if an sa-update channel doesn't exist;
+- altered sa-update to produce an error message if a channel doesn't exist;
 
 - Bug 6150, Bug 6127, Bug 5981, Bug 5950, Bug 6191: let spamd log/report
   a child process exit status or aborting condition in an informative way;
 
-- detect accidental match-everything regexps in rules;
+- added checker to detect accidental match-everything regexps in rules;
 
 - updated garescorer for 3.3.0: use more epochs in GA runs for better scores;
   clarify some mass-check warning output, ensure rule name always appears at
@@ -678,7 +676,7 @@
   the midway point of its score range. this produces better results;
   remove some dead code from masses/score-ranges-from-freqs;
 
-- report performance as iterations per second in garescorer.c;
+- set garescorer.c to report performance as iterations per second;
 
 - added test to ensure that all config settings are correctly handled when
   switching between users; added more config setting type metadata to enable
@@ -689,11 +687,11 @@
   stress tests with xt/50_testname.t scripts to enforce their run before a
   release;
 
-- numerous additional and updated self-tests;
+- made numerous additional and updated self-tests;
 
 - added a Test::Perl::Critic release-test;
 
-- some code cleanups based on suggestions by a perl module Test::Perl::Critic,
+- cleaned up some code based on suggestions by perl module Test::Perl::Critic,
   among others:
   . enable TestingAndDebugging::ProhibitNoStrict test but allow the
     use of 'no strict "refs"';
@@ -703,13 +701,14 @@
   . deal with BayesStore/BDB.pm, Variables::ProhibitConditionalDeclarations
   . now that the module Time::HiRes is a required module, we can afford
     to replace a select() with Time::HiRes::sleep, and remove exception
-    BuiltinFunctions::ProhibitSleepViaSelect from xt/60_perlcritic.t
+    BuiltinFunctions::ProhibitSleepViaSelect from xt/60_perlcritic.t;
 
-- documentation was updated, fixing numerous typos and mistakes in
-  documentation text and in log messages;
+- updated documentation, fixing numerous typos and mistakes in documentation
+  text and in log messages;
 
-- extensive improvements to development process:
-  automated testing through Hudson, improvements to mass-check and rules
+- extensively improved development process:
+  . automated testing through Hudson, a continuous integration tool;
+  . improved mass-check system and rules oversight;
 
 
 About Apache SpamAssassin