Please find, for review, the debconf templates and packages descriptions for the mysqmail source package.
This review will last from Monday, September 14, 2009 to Thursday, September 24, 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:
--- mysqmail.old/debian/mysqmail.templates 2009-09-09 20:00:49.640259474 +0200
+++ mysqmail/debian/mysqmail.templates 2009-09-14 06:59:45.036409664 +0200
@@ -1,9 +1,11 @@
Template: mysqmail/conf_mysqlautoconfig
Type: boolean
Default: true
-_Description: Reuse MySQL auth information from DTC?
- MySQMail can reuse the login and password that DTC will use. This way, you
- will not have to enter any login and passord to configure MySQMail.
+_Description: Reuse MySQL authentication information from DTC?
+ MySQMail can use the same MySQL credentials than DTC.
+ .
+ If you choose this option, you will not be prompted for any login
+ and passord to configure MySQMail.
auth: avoid abbreviations
Be clearer about what "auth" we're talking about. I assumed this is
what you meant.
Template: mysqmail/conf_mysqlhost
Type: string
@@ -15,16 +17,18 @@
Type: string
Default: root
_Description: MySQL Login:
- Enter your MySQL login. MySQMail needs it to access to your MySQL table.
+ Please enter the MySQL login needed to create (and later, access) the MySQMail
+ database.
Use our standard "Please <foo>" formula. I assume that the requested
login is also needed to create the database used by the software.
If so, it should also be mentioned that this login must exist and have
administrative privileges.
Template: mysqmail/conf_mysqlpass
Type: password
_Description: MySQL Password:
- Enter your MySQL password.
+ Please enter the MySQL password needed to create (and later, access) the MySQMail
+ database.
Similar to the former one.
Template: mysqmail/conf_mysqldb
Type: string
Default: dtc
_Description: MySQL database name:
- MySQmail will use it to save trafic for pop3, smtp ftp, and pop3 login
- auth.
+ Please enter the name of the database where MySQmail will store data
+ from POP3, SMTP and FTP servers as well as POP3 authentication credentials.
Put protocol names in capitals (they're acronyms).
--- mysqmail.old/debian/control 2009-09-09 20:00:49.640259474 +0200
+++ mysqmail/debian/control 2009-09-14 07:10:59.551970307 +0200
@@ -12,54 +12,72 @@
Package: mysqmail
Architecture: all
Depends: ${misc:Depends}, debconf, libdotconf1.0, ${shlibs:Depends}
-Description: Use MySQL accouting and auth for most used MTA
- MySQMail is a set of tiny daemon loggers for Qmail, Postfix,
- Pure-ftpd and Courier that will save trafic informations in database.
+Description: mail and FTP accounting and authentication in MySQL
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
It's also a replacement for the qmail standard checkpasswd that
- does the auth via a MySQL table. When done, it setups 2 more
+ performs user authentication via a MySQL table.
+ .
+ When done, it setups 2 more
environment variables: MYSQMAIL_USERNAME MYSQMAIL_DOMAINNAME
that the mysqmail's qmail-pop3d replacement will use to do
the traffic accounting in the MySQL table for this account.
This package holds the configuration file management for
the other packages which share the same /etc/mysqmail.conf:
mysqmail-qmail-logger mysqmail-qmail-pop3d
- mysqmail-postfix-logger and mysqmail-courier-logger
+ mysqmail-postfix-logger and mysqmail-courier-logger.
Rewrite the synopsis:
- no leading article
- no sentence
- no abbreviation
- this is not only for MTAs
Reword the first paragraph so that it can be used as a boilerplate in
all binary packages' descriptions.
I'm not convinced by the third paragraph. IMHO, it does not belong to
a package description. I leave it there mostly untouched, but I think
it could be dropped.
Package: mysqmail-pure-ftpd-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, pure-ftpd | pure-ftpd-mysql, mysqmail, ${shlibs:Depends}
-Description: A MySQL traffic logger for the pure-ftpd transfer.log
- This is a (very small) daemon will log all pure-ftpd traffic
- to SQL, splitting the information by domains and
- users so it's then very easy to count all the ftp traffic for
- a given domain name in real time.
+Description: mail and FTP accounting and authentication in MySQL - pure-ftpd logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all pure-ftpd
+ traffic to SQL, splitting the information by domains and users so
+ it's then very easy to count the entire FTP traffic for a given
+ domain name in real time.
Use the same synopsis with a "general description - specific
description" style
Use the boilerplate
Is this really "pure-ftpd"?
The second paragraph is a pseudo-boilerplate: its structure will
change fro mone package to another but very slightly.
Package: mysqmail-postfix-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, postfix, mysqmail, ${shlibs:Depends}
-Description: A MySQL traffic logger for the Postfix SMTP
- This is a (very small) daemon will log all SMTP traffic
- to SQL, splitting the information by domains and
- users for the from and to field, so it's then very
- easy to count all the SMTP traffic for a given
- domain name. This package is the postfix version.
+Description: mail and FTP accounting and authentication in MySQL - Postfix logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all SMTP
+ traffic to SQL, splitting the information by domains and users for
+ the from and to field, so it's then very easy to count all the SMTP
+ traffic for a given domain name.
+ .
+ This package provides the daemon for Postfix.
Standardize the description and boilerplates. Add a very short
specific paragraph.
Package: mysqmail-courier-logger
Architecture: any
Depends: ${misc:Depends}, courier-imap-ssl | courier-imap | courier-pop | courier-pop-ssl, libdotconf1.0, lsb-base, mysqmail, ${shlibs:Depends}
-Description: MySQL accouting for courier-imap and courier-pop
- This is a (ver small) traffic logger for the C courier-imap,
- courier-imaps, courier-pop and courier-pops daemons to SQL,
- splitting the information by domains and users, so it's then very
- easy to count all the pop and imap traffic for a given
- domain name.
+Description: mail and FTP accounting and authentication in MySQL - Courier loggers
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all IMAP and
+ POP3 traffic to SQL, splitting the information by domains and users
+ for the from and to field, so it's then very easy to count all the
+ IMAP and POP3 traffic for a given domain name.
+ .
+ This package provides the daemon for Courier.
Standardize the description and boilerplates. Add a very short
specific paragraph.
Package: mysqmail-dovecot-logger
Architecture: any
Depends: ${misc:Depends}, dovecot-pop3d, dovecot-imapd, libdotconf1.0, lsb-base, mysqmail, ${shlibs:Depends}
-Description: MySQL accouting for dovecot-pop3d and dovecot-imapd
- This is a (ver small) traffic logger for the C courier-imap,
- courier-imaps, courier-pop and courier-pops daemons to SQL,
- splitting the information by domains and users, so it's then very
- easy to count all the pop and imap traffic for a given
- domain name.
+Description: mail and FTP accounting and authentication in MySQL - Dovecot loggers
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all IMAP and
+ POP3 traffic to SQL, splitting the information by domains and users
+ for the from and to field, so it's then very easy to count all the
+ IMAP and POP3 traffic for a given domain name.
+ .
+ This package provides the daemon for Dovecot.
Standardize the description and boilerplates. Add a very short
specific paragraph.
--
Template: mysqmail/conf_mysqlautoconfig Type: boolean Default: true _Description: Reuse MySQL authentication information from DTC? MySQMail can use the same MySQL credentials than DTC. . If you choose this option, you will not be prompted for any login and passord to configure MySQMail. Template: mysqmail/conf_mysqlhost Type: string Default: localhost _Description: MySQL hostname: Please enter the hostname or IP address of the MySQL server. Template: mysqmail/conf_mysqllogin Type: string Default: root _Description: MySQL Login: Please enter the MySQL login needed to create (and later, access) the MySQMail database. Template: mysqmail/conf_mysqlpass Type: password _Description: MySQL Password: Please enter the MySQL password needed to create (and later, access) the MySQMail database. Template: mysqmail/conf_mysqldb Type: string Default: dtc _Description: MySQL database name: Please enter the name of the database where MySQmail will store data from POP3, SMTP and FTP servers as well as POP3 authentication credentials.
--- mysqmail.old/debian/mysqmail.templates 2009-09-09 20:00:49.640259474 +0200
+++ mysqmail/debian/mysqmail.templates 2009-09-14 06:59:45.036409664 +0200
@@ -1,9 +1,11 @@
Template: mysqmail/conf_mysqlautoconfig
Type: boolean
Default: true
-_Description: Reuse MySQL auth information from DTC?
- MySQMail can reuse the login and password that DTC will use. This way, you
- will not have to enter any login and passord to configure MySQMail.
+_Description: Reuse MySQL authantication information from DTC?
+ MySQMail can use the same MySQL credentials than DTC.
+ .
+ If you choose this option, you will not be prompted for any login
+ and passord to configure MySQMail.
Template: mysqmail/conf_mysqlhost
Type: string
@@ -15,16 +17,18 @@
Type: string
Default: root
_Description: MySQL Login:
- Enter your MySQL login. MySQMail needs it to access to your MySQL table.
+ Please enter the MySQL login needed to create (and later, access) the MySQMail
+ database.
Template: mysqmail/conf_mysqlpass
Type: password
_Description: MySQL Password:
- Enter your MySQL password.
+ Please enter the MySQL password needed to create (and later, access) the MySQMail
+ database.
Template: mysqmail/conf_mysqldb
Type: string
Default: dtc
_Description: MySQL database name:
- MySQmail will use it to save trafic for pop3, smtp ftp, and pop3 login
- auth.
+ Please enter the name of the database where MySQmail will store data
+ from POP3, SMTP and FTP servers as well as POP3 authentication credentials.
--- mysqmail.old/debian/control 2009-09-09 20:00:49.640259474 +0200
+++ mysqmail/debian/control 2009-09-14 07:10:59.551970307 +0200
@@ -12,54 +12,72 @@
Package: mysqmail
Architecture: all
Depends: ${misc:Depends}, debconf, libdotconf1.0, ${shlibs:Depends}
-Description: Use MySQL accouting and auth for most used MTA
- MySQMail is a set of tiny daemon loggers for Qmail, Postfix,
- Pure-ftpd and Courier that will save trafic informations in database.
+Description: mail and FTP accounting and authentication in MySQL
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
It's also a replacement for the qmail standard checkpasswd that
- does the auth via a MySQL table. When done, it setups 2 more
+ performs user authentication via a MySQL table.
+ .
+ When done, it setups 2 more
environment variables: MYSQMAIL_USERNAME MYSQMAIL_DOMAINNAME
that the mysqmail's qmail-pop3d replacement will use to do
the traffic accounting in the MySQL table for this account.
This package holds the configuration file management for
the other packages which share the same /etc/mysqmail.conf:
mysqmail-qmail-logger mysqmail-qmail-pop3d
- mysqmail-postfix-logger and mysqmail-courier-logger
+ mysqmail-postfix-logger and mysqmail-courier-logger.
Package: mysqmail-pure-ftpd-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, pure-ftpd | pure-ftpd-mysql, mysqmail, ${shlibs:Depends}
-Description: A MySQL traffic logger for the pure-ftpd transfer.log
- This is a (very small) daemon will log all pure-ftpd traffic
- to SQL, splitting the information by domains and
- users so it's then very easy to count all the ftp traffic for
- a given domain name in real time.
+Description: mail and FTP accounting and authentication in MySQL - pure-ftpd logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all pure-ftpd
+ traffic to SQL, splitting the information by domains and users so
+ it's then very easy to count the entire FTP traffic for a given
+ domain name in real time.
Package: mysqmail-postfix-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, postfix, mysqmail, ${shlibs:Depends}
-Description: A MySQL traffic logger for the Postfix SMTP
- This is a (very small) daemon will log all SMTP traffic
- to SQL, splitting the information by domains and
- users for the from and to field, so it's then very
- easy to count all the SMTP traffic for a given
- domain name. This package is the postfix version.
+Description: mail and FTP accounting and authentication in MySQL - Postfix logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all SMTP
+ traffic to SQL, splitting the information by domains and users for
+ the from and to field, so it's then very easy to count all the SMTP
+ traffic for a given domain name.
+ .
+ This package provides the daemon for Postfix.
Package: mysqmail-courier-logger
Architecture: any
Depends: ${misc:Depends}, courier-imap-ssl | courier-imap | courier-pop | courier-pop-ssl, libdotconf1.0, lsb-base, mysqmail, ${shlibs:Depends}
-Description: MySQL accouting for courier-imap and courier-pop
- This is a (ver small) traffic logger for the C courier-imap,
- courier-imaps, courier-pop and courier-pops daemons to SQL,
- splitting the information by domains and users, so it's then very
- easy to count all the pop and imap traffic for a given
- domain name.
+Description: mail and FTP accounting and authentication in MySQL - Courier loggers
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all IMAP and
+ POP3 traffic to SQL, splitting the information by domains and users
+ for the from and to field, so it's then very easy to count all the
+ IMAP and POP3 traffic for a given domain name.
+ .
+ This package provides the daemon for Courier.
Package: mysqmail-dovecot-logger
Architecture: any
Depends: ${misc:Depends}, dovecot-pop3d, dovecot-imapd, libdotconf1.0, lsb-base, mysqmail, ${shlibs:Depends}
-Description: MySQL accouting for dovecot-pop3d and dovecot-imapd
- This is a (ver small) traffic logger for the C courier-imap,
- courier-imaps, courier-pop and courier-pops daemons to SQL,
- splitting the information by domains and users, so it's then very
- easy to count all the pop and imap traffic for a given
- domain name.
+Description: mail and FTP accounting and authentication in MySQL - Dovecot loggers
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers
+ that will save traffic information in a MySQL database.
+ .
+ This package provides a very small daemon that will log all IMAP and
+ POP3 traffic to SQL, splitting the information by domains and users
+ for the from and to field, so it's then very easy to count all the
+ IMAP and POP3 traffic for a given domain name.
+ .
+ This package provides the daemon for Dovecot.
Source: mysqmail
Section: mail
Priority: extra
Maintainer: Thomas Goirand <thomas@goirand.fr>
Build-Depends: debhelper (>= 5), po-debconf, libdotconf-dev, libmysqlclient-dev | libmysqlclient15-dev
Standards-Version: 3.8.2
Dm-Upload-Allowed: yes
Vcs-Browser: http://git.gplhost.com/gitweb/?p=mysqmail.git
Vcs-Git: http://git.gplhost.com/mysqmail.git
Homepage: http://www.gplhost.com/software-mysqmail.html
Package: mysqmail
Architecture: all
Depends: ${misc:Depends}, debconf, libdotconf1.0, ${shlibs:Depends}
Description: mail and FTP accounting and authentication in MySQL
MySQMail is a set of tiny daemon loggers for mail and FTP servers
that will save traffic information in a MySQL database.
.
It's also a replacement for the qmail standard checkpasswd that
performs user authentication via a MySQL table.
.
When done, it setups 2 more
environment variables: MYSQMAIL_USERNAME MYSQMAIL_DOMAINNAME
that the mysqmail's qmail-pop3d replacement will use to do
the traffic accounting in the MySQL table for this account.
This package holds the configuration file management for
the other packages which share the same /etc/mysqmail.conf:
mysqmail-qmail-logger mysqmail-qmail-pop3d
mysqmail-postfix-logger and mysqmail-courier-logger.
Package: mysqmail-pure-ftpd-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, pure-ftpd | pure-ftpd-mysql, mysqmail, ${shlibs:Depends}
Description: mail and FTP accounting and authentication in MySQL - pure-ftpd logger
MySQMail is a set of tiny daemon loggers for mail and FTP servers
that will save traffic information in a MySQL database.
.
This package provides a very small daemon that will log all pure-ftpd
traffic to SQL, splitting the information by domains and users so
it's then very easy to count the entire FTP traffic for a given
domain name in real time.
Package: mysqmail-postfix-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, postfix, mysqmail, ${shlibs:Depends}
Description: mail and FTP accounting and authentication in MySQL - Postfix logger
MySQMail is a set of tiny daemon loggers for mail and FTP servers
that will save traffic information in a MySQL database.
.
This package provides a very small daemon that will log all SMTP
traffic to SQL, splitting the information by domains and users for
the from and to field, so it's then very easy to count all the SMTP
traffic for a given domain name.
.
This package provides the daemon for Postfix.
Package: mysqmail-courier-logger
Architecture: any
Depends: ${misc:Depends}, courier-imap-ssl | courier-imap | courier-pop | courier-pop-ssl, libdotconf1.0, lsb-base, mysqmail, ${shlibs:Depends}
Description: mail and FTP accounting and authentication in MySQL - Courier loggers
MySQMail is a set of tiny daemon loggers for mail and FTP servers
that will save traffic information in a MySQL database.
.
This package provides a very small daemon that will log all IMAP and
POP3 traffic to SQL, splitting the information by domains and users
for the from and to field, so it's then very easy to count all the
IMAP and POP3 traffic for a given domain name.
.
This package provides the daemon for Courier.
Package: mysqmail-dovecot-logger
Architecture: any
Depends: ${misc:Depends}, dovecot-pop3d, dovecot-imapd, libdotconf1.0, lsb-base, mysqmail, ${shlibs:Depends}
Description: mail and FTP accounting and authentication in MySQL - Dovecot loggers
MySQMail is a set of tiny daemon loggers for mail and FTP servers
that will save traffic information in a MySQL database.
.
This package provides a very small daemon that will log all IMAP and
POP3 traffic to SQL, splitting the information by domains and users
for the from and to field, so it's then very easy to count all the
IMAP and POP3 traffic for a given domain name.
.
This package provides the daemon for Dovecot.
Attachment:
signature.asc
Description: Digital signature