[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] templates://sa-exim/{templates}



Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

[...]
>   There are some saved mails in subdirectories of /var/spool/sa-exim.
> - Depending on the configuration sa-exim will save mails matching specific
> + Depending on the configuration, sa-exim may save mails matching specific
>   criterias (an error occured, rejected as spam, passed through although
            ^               ^
Singular criterion, plural criteria.  OccuRRed.

> - recognized as spam, ...) in subdirectories of /var/spool/sa-exim.
> + recognized as spam, etc.) in these directories.
> 
> etc. is better than an ellispsis in parenthesis (at least IMHO)

Yes, this (x, y, z ...) style always feels subtly un-anglophone,
especially with its space-before-ellipsis.  Make it obviously a list
of example classifications from the start - assuming that's what it
is... if it's meant to be a list of full-sentence situation
descriptions it needs more work.

    criteria (such as "an error occurred", "rejected as spam", or "passed
    through although recognized as spam") in these directories.

[...]
> -Description: Use spamAssassin at SMTP time with the Exim v4 MTA
> - SA-Exim lets you use spamAssassin at SMTP time with the Exim
> - v4 MTA, which enables you to do many things with incoming Emails, 
> - including refusing them before they come in, or even teergrubing the 
> - sender (i.e. slowing him down, by tying his resources)
> +Description: spamAssassin filter for Exim v4
> 
> No verb sentence in synopsis. More synthtic description

Upstream say "SpamAssassin" (which makes the SA more obvious), and
I'd drop the "v4" in the short description since this works with
either of the Exim daemon packages in Debian.

> + SA-Exim allows using spamAssassin at SMTP time with the Exim
> + v4 MTA. It may be ysed to reject incoming mails
> + before they come in, or even teergrub the
> + sender (by slowing down the connection and tying resources).
> 
> 
> Yet another "allows", I know..:-)...but that avoids "lets you" (that
> might be not "me" but another admin of the same machine, or whatever).

The other common problem with "allows" is that nothing was
"forbidding" the use of SMTP-time filters before SA-Exim came along.
It can't claim to "enable" it, either - Exim can do all this on its
own.

Then the "teergrubing".  I suspect this is the only place I've ever
seen it as a verb... it should be "teergrube", and it seems
unhelpful to introduce the word like this if it's just going to have
to be explained anyway.  Put it the other way round, with the jargon
term in the parentheses.

    SA-Exim integrates SpamAssassin filtering at SMTP time with the Exim
    v4 MTA. It may be used to reject incoming mails before they arrive, or
    even to tie up the sender's resources by slowing down the connection
    ("teergrubing").

> - Note: Most of the functionality of this package can also be achieved
> - using the exiscan ACL conditions built into the "heavy" Exim daemon, 
> - exim-daemon-heavy. You should use this package if:
> - .
> -  * you want to use SpamAssassin's report_safe feature, or
> -  * you want easier control over the header fields added, without using
> -    the report template to add multiple fields.
> + Most of the functionality of this package can also be achieved
> + using the exiscan ACL conditions built into the "heavy" Exim daemon,
> + exim-daemon-heavy. This package should be used either if you want to use
> + SpamAssassin's report_safe feature or have an
> + easier control over the header fields added, without using
> + the report template to add multiple fields.

I'd rephrase slightly:

    Most of the functionality of this package can also be achieved
    using the exiscan ACL conditions built into the "heavy" Exim daemon,
    exim-daemon-heavy. Use this package if you need SpamAssassin's
    report_safe feature, or if you want to have easier control over the
    header fields added, without using the report template to add multiple
    fields.

(But I'm not sure I see how the "without..." bit fits in.)
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../sa-exim.old/debian/templates	2009-02-05 18:44:37.000000000 +0000
+++ debian/templates	2009-02-09 10:39:40.000000000 +0000
@@ -1,11 +1,11 @@
 Template: sa-exim/purge_spool
 Type: boolean
 Default: false
-_Description: Remove saved mails in spool directory?
+_Description: Remove saved mails in sa-exim's spool directory?
  There are some saved mails in subdirectories of /var/spool/sa-exim.
- Depending on the configuration sa-exim will save mails matching specific
- criterias (an error occured, rejected as spam, passed through although
- recognized as spam, ...) in subdirectories of /var/spool/sa-exim.
+ Depending on the configuration, sa-exim may save mails matching specific
+ criteria (such as "an error occurred", "rejected as spam", or "passed
+ through although recognized as spam") in these directories.
  .
- You can keep them for further analysis and later remove them manually or
- decide to delete them now.
+ Please choose whether you want to keep these mails for further analysis
+ or delete them now.
--- ../sa-exim.old/debian/control	2009-02-05 18:44:37.000000000 +0000
+++ debian/control	2009-02-09 10:34:25.000000000 +0000
@@ -13,16 +13,15 @@
 Depends: ${exim:Depends}, spamc, ${shlibs:Depends}, debconf (>= 1.2.0) | debconf-2.0
 Recommends: ${perl:Depends}
 Suggests: spamassassin
-Description: Use spamAssassin at SMTP time with the Exim v4 MTA
- SA-Exim lets you use spamAssassin at SMTP time with the Exim
- v4 MTA, which enables you to do many things with incoming Emails, 
- including refusing them before they come in, or even teergrubing the 
- sender (i.e. slowing him down, by tying his resources)
+Description: SpamAssassin filter for Exim
+ SA-Exim integrates SpamAssassin filtering at SMTP time with the Exim
+ v4 MTA. It may be used to reject incoming mails before they arrive, or
+ even to tie up the sender's resources by slowing down the connection
+ ("teergrubing").
  .
- Note: Most of the functionality of this package can also be achieved
- using the exiscan ACL conditions built into the "heavy" Exim daemon, 
- exim-daemon-heavy. You should use this package if:
- .
-  * you want to use SpamAssassin's report_safe feature, or
-  * you want easier control over the header fields added, without using
-    the report template to add multiple fields.
+ Most of the functionality of this package can also be achieved
+ using the exiscan ACL conditions built into the "heavy" Exim daemon,
+ exim-daemon-heavy. Use this package if you need SpamAssassin's
+ report_safe feature, or if you want to have easier control over the
+ header fields added, without using the report template to add multiple
+ fields.
Template: sa-exim/purge_spool
Type: boolean
Default: false
_Description: Remove saved mails in sa-exim's spool directory?
 There are some saved mails in subdirectories of /var/spool/sa-exim.
 Depending on the configuration, sa-exim may save mails matching specific
 criteria (such as "an error occurred", "rejected as spam", or "passed
 through although recognized as spam") in these directories.
 .
 Please choose whether you want to keep these mails for further analysis
 or delete them now.
Source: sa-exim
Section: mail
Priority: optional
Maintainer: Magnus Holmgren <holmgren@debian.org>
Build-Depends: debhelper (>= 4.1.16), links, exim4-dev
Standards-Version: 3.8.0
Vcs-Svn: svn://svn.kibibyte.se/sa-exim/trunk
Vcs-Browser: http://svn.kibibyte.se/sa-exim
Homepage: http://marc.merlins.org/linux/exim/sa.html

Package: sa-exim
Architecture: any
Depends: ${exim:Depends}, spamc, ${shlibs:Depends}, debconf (>= 1.2.0) | debconf-2.0
Recommends: ${perl:Depends}
Suggests: spamassassin
Description: SpamAssassin filter for Exim
 SA-Exim integrates SpamAssassin filtering at SMTP time with the Exim
 v4 MTA. It may be used to reject incoming mails before they arrive, or
 even to tie up the sender's resources by slowing down the connection
 ("teergrubing").
 .
 Most of the functionality of this package can also be achieved
 using the exiscan ACL conditions built into the "heavy" Exim daemon,
 exim-daemon-heavy. Use this package if you need SpamAssassin's
 report_safe feature, or if you want to have easier control over the
 header fields added, without using the report template to add multiple
 fields.

Reply to: