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

Re: [RFR] templates://mysqmail/{mysqmail.templates}



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

Oh, mYsqmail.  Whereas the one that passed through the list nearly a
year ago was mAsqmail.

>  Template: mysqmail/conf_mysqlautoconfig
[...]
> +_Description: Reuse MySQL authentication information from DTC?
> + MySQMail can use the same MySQL credentials than DTC.
                                                as
> + .
> + If you choose this option, you will not be prompted for any login
                                                             a
> + and passord to configure MySQMail.
           ^w

>  Template: mysqmail/conf_mysqlhost

You left this one unchanged:

>  _Description: MySQL hostname:         
>    Please enter the hostname or IP address of the MySQL server.

I could imagine this being confusing under the wrong circumstances -
add "for MySQMail".

>   Template: mysqmail/conf_mysqllogin
[...]
>  _Description: MySQL Login:
                       l
[...]
>  Template: mysqmail/conf_mysqlpass
>  Type: password
>  _Description: MySQL Password:
                       p

>  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.

If I'm installing mysqmail-postfix I don't want it to start asking
me questions about data from POP3 and FTP servers.

    Please enter the name of the database where MySQMail will store its data.

In the control file:
>  Package: mysqmail
[...]
> -Description: Use MySQL accouting and auth for most used MTA
> +Description: mail and FTP accounting and authentication in MySQL

Easy to misread as "mail (and other things) in MySQL"; and the
authentication part seems to have been stripped out anyway.  I'd
suggest cutting this down to:

   Description: traffic-logging system in MySQL

> - MySQMail is a set of tiny daemon loggers for Qmail, Postfix,
> - Pure-ftpd and Courier that will save trafic informations in database.
> + MySQMail is a set of tiny daemon loggers for mail and FTP servers
> + that will save traffic information in a MySQL database.

No need for "will", just make it "that saves traffic information".
On the other hand we could move the part about splitting the
information by domain and by user into this paragraph.

> Reword the first paragraph so that it can be used as a boilerplate in
> all binary packages' descriptions.

But meanwhile, Thomas Goirand <thomas@goirand.fr> writes:
# I do agree with all changes, and would remove the 2nd and 3rd paragraph
# of the mysqmail binary package (1st one in the control file), as the
# qmail stuffs are not part of the package anymore.

This leaves me with boilerplate and no package-specific material!
As far as I can see it's basically mysqmail-common:

   Description: traffic-logging system in MySQL
    MySQMail is a set of tiny daemon loggers for mail and FTP servers that
    save traffic information in a MySQL database. The information is split
    by domain and by user so that it's easy to measure all the traffic for
    a given domain name in real time.
    .
    This package provides the configuration infrastructure.

>  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.
> 
> Use the same synopsis with a "general description - specific
> description" style
> 
> Use the boilerplate
> 
> Is this really "pure-ftpd"?

That's the packagename; the "brand name" is Pure-FTPd.  Wouldn't a
dependency on "pure-ftpd | pure-ftpd-mysql" be satisfied by
pure-ftpd-postgresql?  I suppose you could make that work, though,
so it's not actually a bug.

> The second paragraph is a pseudo-boilerplate: its structure will
> change fro mone package to another but very slightly.

My "homogenised boilerplate" approach makes this just:

   Description: traffic-logging system in MySQL - Pure-FTPd logger
    MySQMail is a set of tiny daemon loggers for mail and FTP servers that
    save traffic information in a MySQL database. The information is split
    by domain and by user so that it's easy to measure all the traffic for
    a given domain name in real time.
    .
    This package provides a logger for FTP traffic handled by Pure-FTPd.

If a mysqmail-qmail package arrives later (typing that packagename
gives me hiccups) it'll need a longer final paragraph pointing out
that "this particular logger also handles authentication data". 

>  Package: mysqmail-postfix-logger

   Description: traffic-logging system in MySQL - Postfix logger
   $BOILERPLATE
   This package provides a logger for SMTP traffic handled by Postfix.
 
>  Package: mysqmail-courier-logger

   Description: traffic-logging system in MySQL - Courier logger
   $BOILERPLATE
   This package provides a logger for POP/IMAP traffic handled by Courier.
  
>  Package: mysqmail-dovecot-logger

   Description: traffic-logging system in MySQL - Dovecot logger
   $BOILERPLATE
   This package provides a logger for POP/IMAP traffic handled by Dovecot.

(A last-minute thought: if the formula was
   Description: logging system in MySQL - Dovecot traffic-logger
that would make it easier in future to introduce a
   Description: logging system in MySQL - Qmail auth and traffic logger
Worth doing?)
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../mysqmail-0.4.7.pristine/debian/mysqmail.templates	2009-09-09 20:26:01.000000000 +0100
+++ debian/mysqmail.templates	2009-09-14 12:08:09.000000000 +0100
@@ -1,30 +1,33 @@
 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 as DTC.
+ .
+ If you choose this option, you will not be prompted for a login
+ and password 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.
+ Please enter the hostname or IP address of the MySQL server for MySQMail.
 
 Template: mysqmail/conf_mysqllogin
 Type: string
 Default: root
-_Description: MySQL Login:
- Enter your MySQL login. MySQMail needs it to access to your MySQL table.
+_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:
- Enter your MySQL 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:
- 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 its data.
--- ../mysqmail-0.4.7.pristine/debian/control	2009-09-09 20:26:01.000000000 +0100
+++ debian/control	2009-09-14 12:08:30.000000000 +0100
@@ -12,54 +12,54 @@
 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.
- It's also a replacement for the qmail standard checkpasswd that
- does the auth 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
+Description: traffic-logging system in MySQL
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers that
+ save traffic information in a MySQL database. The information is split
+ by domain and by user so that it's easy to measure all the traffic for
+ a given domain name in real time.
+ .
+ This package provides the configuration infrastructure.
 
 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
+Description: traffic-logging system in MySQL - Pure-FTPd logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers that
+ save traffic information in a MySQL database. The information is split
+ by domain and by user so that it's easy to measure all the traffic for
  a given domain name in real time.
+ .
+ This package provides a logger for FTP traffic handled by Pure-FTPd.
 
 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: traffic-logging system in MySQL - Postfix logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers that
+ save traffic information in a MySQL database. The information is split
+ by domain and by user so that it's easy to measure all the traffic for
+ a given domain name in real time.
+ .
+ This package provides a logger for SMTP traffic handled by 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: traffic-logging system in MySQL - Courier logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers that
+ save traffic information in a MySQL database. The information is split
+ by domain and by user so that it's easy to measure all the traffic for
+ a given domain name in real time.
+ .
+ This package provides a logger for POP/IMAP traffic handled by 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: traffic-logging system in MySQL - Dovecot logger
+ MySQMail is a set of tiny daemon loggers for mail and FTP servers that
+ save traffic information in a MySQL database. The information is split
+ by domain and by user so that it's easy to measure all the traffic for
+ a given domain name in real time.
+ .
+ This package provides a logger for POP/IMAP traffic handled by Dovecot.
Template: mysqmail/conf_mysqlautoconfig
Type: boolean
Default: true
_Description: Reuse MySQL authentication information from DTC?
 MySQMail can use the same MySQL credentials as DTC.
 .
 If you choose this option, you will not be prompted for a login
 and password 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 for MySQMail.

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 its data.
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: traffic-logging system in MySQL
 MySQMail is a set of tiny daemon loggers for mail and FTP servers that
 save traffic information in a MySQL database. The information is split
 by domain and by user so that it's easy to measure all the traffic for
 a given domain name in real time.
 .
 This package provides the configuration infrastructure.

Package: mysqmail-pure-ftpd-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, pure-ftpd | pure-ftpd-mysql, mysqmail, ${shlibs:Depends}
Description: traffic-logging system in MySQL - Pure-FTPd logger
 MySQMail is a set of tiny daemon loggers for mail and FTP servers that
 save traffic information in a MySQL database. The information is split
 by domain and by user so that it's easy to measure all the traffic for
 a given domain name in real time.
 .
 This package provides a logger for FTP traffic handled by Pure-FTPd.

Package: mysqmail-postfix-logger
Architecture: any
Depends: ${misc:Depends}, libdotconf1.0, lsb-base, postfix, mysqmail, ${shlibs:Depends}
Description: traffic-logging system in MySQL - Postfix logger
 MySQMail is a set of tiny daemon loggers for mail and FTP servers that
 save traffic information in a MySQL database. The information is split
 by domain and by user so that it's easy to measure all the traffic for
 a given domain name in real time.
 .
 This package provides a logger for SMTP traffic handled by 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: traffic-logging system in MySQL - Courier logger
 MySQMail is a set of tiny daemon loggers for mail and FTP servers that
 save traffic information in a MySQL database. The information is split
 by domain and by user so that it's easy to measure all the traffic for
 a given domain name in real time.
 .
 This package provides a logger for POP/IMAP traffic handled by Courier.

Package: mysqmail-dovecot-logger
Architecture: any
Depends: ${misc:Depends}, dovecot-pop3d, dovecot-imapd, libdotconf1.0, lsb-base, mysqmail, ${shlibs:Depends}
Description: traffic-logging system in MySQL - Dovecot logger
 MySQMail is a set of tiny daemon loggers for mail and FTP servers that
 save traffic information in a MySQL database. The information is split
 by domain and by user so that it's easy to measure all the traffic for
 a given domain name in real time.
 .
 This package provides a logger for POP/IMAP traffic handled by Dovecot.

Reply to: