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

[RFR] templates://crm114/{crm114.templates}



Please find, for review, the debconf templates and packages descriptions for the crm114 source package.

This review will last from Wednesday, September 09, 2009 to Saturday, September 19, 2009.

Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.

Your review should be sent as an answer to this mail.

When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.

When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.

Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.

Rationale:
--- crm114.old/debian/crm114.templates	2009-09-05 16:41:17.398218370 +0200
+++ crm114/debian/crm114.templates	2009-09-09 07:28:50.646815917 +0200
@@ -1,17 +1,17 @@
 Template: crm114/cssupgrade
 Type: boolean
 Default: false
-_Description: Is it safe to upgrade crm114 now?
- crm114 package is going to get upgraded to a new version that cannot read .css
- files created by the currently installed crm114 version.  This means any
- crm114 command is likely to fail with an error code, possibly rejecting
+_Description: Proceed with CRM114 upgrade?

The original synopsis fails one suggestion (see DevRef): it should be
"autonomous" and could be used (and understood) without the need of
reading the long description.

Of course, in many case, that's quite rethorical, but here it seems
better to make it clearer: we ask the user if (s)he wants to upgrade,
not exactly if this is safe..:-)


+ The version of the crm114 package that is about to be installed is
+ not able to use .css files created by the currently installed version. This means
+ that any crm114 command is likely to fail with an error code, possibly rejecting
  incoming e-mail.


Avoid leading lowercase which always looks ugly.

This means *that*....but I suspect our native speakers will find
something better.

  .
- If you use crm114 during your e-mail delivery, it is highly recommended that
- you stop your e-mail delivery or disable crm114 processing before permitting
- the package upgrade.
+ If crm114 is an important piece for e-mail delivery on this machine,
+ it is highly recommended that
+ you delay the upgrade until you have analyzed the situation.


Avoid "you use". After all, the person doing the upgrade might not be
the one using crm114 and his|her e-mail is of course not the only one
that could be affected. Rethorical, again, but we generally discourage
possessive forms.

  .
- After the upgrade is finished, please check carefully whether crm114 still
- works with your current .css files.  If it does not, use your mailreaver cache
- to rebuild the .css files or create new .css files from scratch.  Then you
- can enable your e-mail delivery again.
+ If you proceed with the upgrade, you should carefully check whether crm114
+ is still properly operating with existing .css files. If it does not, these
+ files should be rebuilt by using the mailreaver cache, or recreated from
+ scratch.

Other attemps to avoid possessive form.



--- crm114.old/debian/control	2009-09-05 16:41:17.398218370 +0200
+++ crm114/debian/control	2009-09-09 07:35:35.690067543 +0200
@@ -11,20 +11,20 @@
 Pre-Depends: debconf
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Recommends: metamail | mew-bin
-Description: The Controllable Regex Mutilator and Spam Filter
- CRM114 is a system to examine incoming e-mail, system log streams, data
+Description: versatile filtering system for email and other data
+ CRM114 stands for "The Controllable Regex Mutilator and Spam Filter".
+ .

The synopsis is definitely not well adapted as it makes impossible for
someone to understand the general purpose of the software. Not to
mention the invasive capitals, of course..:)

So, I make a neutral proposal and I re-use the upstream definition as
an introduction.


+ It is a system to examine incoming e-mail, system log streams, data
  files or other data streams, and to sort, filter, or alter the incoming
  files or data streams according to whatever the user desires. Criteria for
  categorization of data can be by satisfaction of regexes, by sparse binary
  polynomial matching with a Bayesian Chain Rule evaluator, or by other means.
- Accuracy of the SBPH/BCR classifier has been seen in excess of 99 per cent,
- for 1/4 megabyte of learning text. In other words, CRM114 learns, and it
- learns fast.

The last sentences are a little bit too close to "advertisement" as
discouraged by the DevRef. Neutral language is the key, here.

  .
  CRM114 is compatible with SpamAssassin or other spam-flagging software; it
  can also be pipelined in front of or behind procmail. CRM114 is also useful
- as a syslog or firewall log filter, to alert you to important events but
+ as a syslog or firewall log filter, to alert about important events but
  ignore the ones that aren't meaningful.

Not only "you"..:-)

  .
- For mailfiltering you need to install metamail or mew-bin package to have
- some tool to decode mime attachments.
+ For mail filtering, installing metamail or mew-bin packages is
+ recommended in order to have
+ tools to decode MIME attachments.

Avoid using one-word contructions (we had a recent debate in dle about
this but I think that, here, the contraction is less common than
"filesystem").

s/mime/MIME (acronym)

-- 


Template: crm114/cssupgrade
Type: boolean
Default: false
_Description: Proceed with CRM114 upgrade?
 The version of the crm114 package that is about to be installed is
 not able to use .css files created by the currently installed version. This means
 that any crm114 command is likely to fail with an error code, possibly rejecting
 incoming e-mail.
 .
 If crm114 is an important piece for e-mail delivery on this machine,
 it is highly recommended that
 you delay the upgrade until you have analyzed the situation.
 .
 If you proceed with the upgrade, you should carefully check whether crm114
 is still properly operating with existing .css files. If it does not, these
 files should be rebuilt by using the mailreaver cache, or recreated from
 scratch.
--- crm114.old/debian/crm114.templates	2009-09-05 16:41:17.398218370 +0200
+++ crm114/debian/crm114.templates	2009-09-09 07:28:50.646815917 +0200
@@ -1,17 +1,17 @@
 Template: crm114/cssupgrade
 Type: boolean
 Default: false
-_Description: Is it safe to upgrade crm114 now?
- crm114 package is going to get upgraded to a new version that cannot read .css
- files created by the currently installed crm114 version.  This means any
- crm114 command is likely to fail with an error code, possibly rejecting
+_Description: Proceed with CRM114 upgrade?
+ The version of the crm114 package that is about to be installed is
+ not able to use .css files created by the currently version. This means
+ that any crm114 command is likely to fail with an error code, possibly rejecting
  incoming e-mail.
  .
- If you use crm114 during your e-mail delivery, it is highly recommended that
- you stop your e-mail delivery or disable crm114 processing before permitting
- the package upgrade.
+ If crm114 is an important pieve for e-mail delivery on this machine,
+ it is highly recommended that
+ you delay the upgrade until you have analyzed the situation.
  .
- After the upgrade is finished, please check carefully whether crm114 still
- works with your current .css files.  If it does not, use your mailreaver cache
- to rebuild the .css files or create new .css files from scratch.  Then you
- can enable your e-mail delivery again.
+ If you proceed with the upgrade, you should carefully check whether crm114
+ is still properly operating with existing .css files. If it does not, these
+ files should be rebuilt by using the mailreaver cache, or recreated from
+ scratch.
--- crm114.old/debian/control	2009-09-05 16:41:17.398218370 +0200
+++ crm114/debian/control	2009-09-09 07:35:35.690067543 +0200
@@ -11,20 +11,20 @@
 Pre-Depends: debconf
 Depends: ${shlibs:Depends}, ${misc:Depends}
 Recommends: metamail | mew-bin
-Description: The Controllable Regex Mutilator and Spam Filter
- CRM114 is a system to examine incoming e-mail, system log streams, data
+Description: versatile filtering system for email and other data
+ CRM114 stands for "The Controllable Regex Mutilator and Spam Filter".
+ .
+ It is a system to examine incoming e-mail, system log streams, data
  files or other data streams, and to sort, filter, or alter the incoming
  files or data streams according to whatever the user desires. Criteria for
  categorization of data can be by satisfaction of regexes, by sparse binary
  polynomial matching with a Bayesian Chain Rule evaluator, or by other means.
- Accuracy of the SBPH/BCR classifier has been seen in excess of 99 per cent,
- for 1/4 megabyte of learning text. In other words, CRM114 learns, and it
- learns fast.
  .
  CRM114 is compatible with SpamAssassin or other spam-flagging software; it
  can also be pipelined in front of or behind procmail. CRM114 is also useful
- as a syslog or firewall log filter, to alert you to important events but
+ as a syslog or firewall log filter, to alert about important events but
  ignore the ones that aren't meaningful.
  .
- For mailfiltering you need to install metamail or mew-bin package to have
- some tool to decode mime attachments.
+ For mail filtering, installing metamail or mew-bin packages is
+ recommended in order to have
+ tools to decode MIME attachments.
Source: crm114
Section: mail
Priority: optional
Maintainer: Milan Zamazal <pdm@debian.org>
Build-Depends: debhelper (>= 7), dpatch, libtre-dev (>= 0.6.8), po-debconf
Standards-Version: 3.8.3
Homepage: http://crm114.sourceforge.net

Package: crm114
Architecture: any
Pre-Depends: debconf
Depends: ${shlibs:Depends}, ${misc:Depends}
Recommends: metamail | mew-bin
Description: versatile filtering system for email and other data
 CRM114 stands for "The Controllable Regex Mutilator and Spam Filter".
 .
 It is a system to examine incoming e-mail, system log streams, data
 files or other data streams, and to sort, filter, or alter the incoming
 files or data streams according to whatever the user desires. Criteria for
 categorization of data can be by satisfaction of regexes, by sparse binary
 polynomial matching with a Bayesian Chain Rule evaluator, or by other means.
 .
 CRM114 is compatible with SpamAssassin or other spam-flagging software; it
 can also be pipelined in front of or behind procmail. CRM114 is also useful
 as a syslog or firewall log filter, to alert about important events but
 ignore the ones that aren't meaningful.
 .
 For mail filtering, installing metamail or mew-bin packages is
 recommended in order to have
 tools to decode MIME attachments.

Attachment: signature.asc
Description: Digital signature


Reply to: