You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@spamassassin.apache.org by bu...@bugzilla.spamassassin.org on 2007/08/17 04:36:16 UTC

[Bug 5608] New: Say sa-compile is not for user_prefs

http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608

           Summary: Say sa-compile is not for user_prefs
           Product: Spamassassin
           Version: 3.2.3
          Platform: Other
        OS/Version: other
            Status: NEW
          Severity: trivial
          Priority: P5
         Component: sa-compile
        AssignedTo: dev@spamassassin.apache.org
        ReportedBy: jidanni@jidanni.org


Mention on the sa-compile man page that sa-compile has nothing to do with one's
user_prefs file! Don't dream that you can compile your user_prefs file!



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From lwilton@earthlink.net  2007-12-07 23:21 -------
> Is that explicit enough? 

Nope. Let's catch the whole case for the literal-minded:

"sa-compile uses "re2c" to compile all parts of the SpamAssassin ruleset except
for user_prefs or any files #included from user_prefs. Rules in user_prefs or 
files included from user_prefs cannot be built into the compiled set."

This should prevent people from moving their user_prefs contents to 
my_compiled_rules and then #include "my_compiled_rules" in their user_prefs and 
expecting the rules to get compiled.




------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From mkettler_sa@verizon.net  2007-12-06 20:56 -------
Good point. I guess the better thing to change 

"sa-compile uses "re2c" to compile the SpamAssassin ruleset"

to
"sa-compile uses "re2c" to compile all parts of the SpamAssassin ruleset except
user_prefs"


It is also particularly misleading that sa-compile supports the -p option.. 



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jidanni@jidanni.org  2007-08-18 18:11 -------
Remember that there are still regular users who don't wish to install
spamassassin themselves, and instead just use /usr/bin/spamassassin. Thus
user_prefs still has a place in this world.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From spamassassin@dostech.ca  2007-12-07 11:17 -------
> > you'll have people using "include" in their user_prefs file to include .cf files
> 
> I hope you say explicitly somewhere this is a no-no.

Why?  There's nothing wrong with using "include <file>" in a user_prefs file. 
Doing so won't get you the rules compiled and Matt's original wording wasn't
clear on that point.

The documentation can't spell out every possible outcome for every possible
configuration.  At some point people have to read the documentation and then use
their brain to figure out how it applies to their particular situation.





------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jidanni@jidanni.org  2007-08-18 03:24 -------
I and perhaps many people are looking for a way to "compile" our user_prefs
files to make them run faster.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608


sidney@sidney.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED




------- Additional Comments From sidney@sidney.com  2007-12-17 16:32 -------
$ svn ci -m "bug 5608 - more correct wording in POD documentation" sa-compile.raw
Sending        sa-compile.raw
Transmitting file data .
Committed revision 605053.

$ cd ../branches/3.2/
$ svn ci -m "bug 5608 - more correct wording in POD documentation" sa-compile.raw
Sending        sa-compile.raw
Transmitting file data .
Committed revision 605054.





------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From felicity@apache.org  2007-08-18 07:57 -------
I would argue that if you cared about performance, you wouldn't be putting rules
in user_prefs.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From spamassassin@dostech.ca  2007-12-06 20:39 -------
> However, we probably should point out in the docs that sa-compile doesn't work
> on user_prefs, or at least specify it only works on .cf files.

Not "only on .cf files"... say that and you'll have people using "include" in
their user_prefs file to include .cf files. :)



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From mkettler_sa@verizon.net  2007-12-11 19:59 -------
Created an attachment (id=4206)
 --> (http://issues.apache.org/SpamAssassin/attachment.cgi?id=4206&action=view)
Patch against 3.2 SVN branch

Patch to make the sa-compile docs slightly more verbose, as specified.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jidanni@jidanni.org  2007-12-07 10:00 -------
>"sa-compile uses "re2c" to compile all parts of the SpamAssassin ruleset except
>user_prefs"

for which it uses a different tool? Say clearly not to compile user_prefs!

> you'll have people using "include" in their user_prefs file to include .cf files

I hope you say explicitly somewhere this is a no-no.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From mkettler_sa@verizon.net  2007-12-06 20:12 -------
Agreed, user_prefs has a place in the world. This isn't it. It they have lots of
rules and want to compile them, they should be using --siteconfigpath to point
to an alternate site directory (instead of /etc/mail/spamassassin) of .cf files,
which can be sa-compiled.

Agreed, anyone wanting performance won't put rules into user_prefs in the first
place. That's going to kill performance by the very nature of user_prefs being
loaded on a per-email basis. Using sa-compile would only marginally speed up
something that's absurdly slow.

However, we probably should point out in the docs that sa-compile doesn't work
on user_prefs, or at least specify it only works on .cf files. It may be obvious
to us that it's a foolish endeavor.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From mkettler_sa@verizon.net  2007-12-07 18:21 -------
Fine:

"sa-compile uses "re2c" to compile all parts of the SpamAssassin ruleset except
user_prefs. Rules in user_prefs cannot be built into the compiled set."

Is that explicit enough? It should also make a hint that there's only *ONE*
system-wide compiled set. Hopefully this will lead them to realize this is why 
only system-wide files can be compiled there. (unlike user_prefs, which are by
definition intended to be used for per-user settings).








------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jm@jmason.org  2007-12-17 13:01 -------
(In reply to comment #17)
> Documentation is CTR... since we're all voting anyway, I vote +1 for getting
> Matt an apache.org account and commit karma (given that he's an SA PMC member
> and all that). ;)

he keeps refusing! ;)



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jm@jmason.org  2007-12-17 01:54 -------
+1



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From spamassassin@dostech.ca  2007-12-17 13:04 -------
Perhaps we should get Matt's wife to nag him! :evil:



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jidanni@jidanni.org  2007-08-18 03:22 -------
Or say how to compile one's user_prefs file. stat(1) shows sa-compile does not
know about one's user_prefs file.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jidanni@jidanni.org  2007-12-07 21:38 -------
> Rules in user_prefs cannot be built into the compiled set."

<Is that explicit enough?

Add:
So don't compile user_prefs.



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From mkettler_sa@verizon.net  2007-12-08 08:22 -------
While we're at it, I'd rather be more explicit that it's site-wide configuration
that can be complied.

As for the "So don't compile user_prefs.", I object to that. It's redundant and
sounds condescending to me. Saying something can't be done is sufficient, but if
you want, we can broaden it to "No part of user_prefs".

So, how about:

"sa-compile uses "re2c" to compile the site-wide parts of the SpamAssassin
ruleset . No part of user_prefs or any files included from user_prefs can be
built into the compiled set."

That should make it really obvious you can't compile user_prefs.
 







------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From jm@jmason.org  2007-08-17 01:44 -------
why would you think that?



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

[Bug 5608] Say sa-compile is not for user_prefs

Posted by bu...@bugzilla.spamassassin.org.
http://issues.apache.org/SpamAssassin/show_bug.cgi?id=5608





------- Additional Comments From spamassassin@dostech.ca  2007-12-17 12:55 -------
Documentation is CTR... since we're all voting anyway, I vote +1 for getting
Matt an apache.org account and commit karma (given that he's an SA PMC member
and all that). ;)



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.