svn commit: rev 43313 - spamassassin/trunk/lib/Mail

[jm...@apache.org]

Author: jm
Date: Fri Sep  3 20:02:23 2004
New Revision: 43313

Modified:
   spamassassin/trunk/lib/Mail/SpamAssassin.pm
Log:
bug 3711: doco fix: correct the read_scoreonly_config() POD documentation to reflect that it no longer is just scores.

Modified: spamassassin/trunk/lib/Mail/SpamAssassin.pm
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin.pm	(original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin.pm	Fri Sep  3 20:02:23 2004
@@ -964,9 +964,13 @@
 
 =item $f->read_scoreonly_config ($filename)
 
-Read a configuration file and parse only scores from it.  This is used
-to safely allow multi-user daemons to read per-user config files
-without having to use C<setuid()>.
+Read a configuration file and parse user preferences from it.
+
+User preferences are as defined in the C<Mail::SpamAssassin::Conf> manual page.
+In other words, they include scoring options, scores, whitelists and
+blacklists, and so on, but do not include rule definitions, privileged
+settings, etc. unless C<allow_user_rules> is enabled; and they never include
+the administrator settings.
 
 =cut