Re: [RFR] templates://qmail/{qmail.templates}
Thank you for working on this Christian.
I like the changes, and I approve all of them without exception. Please let me know how you would like me to proceed. Shall I wait for your bug report to file a new package, or shall I do that now?
Cheers!
Jon
On Mar 22, 2010, at 12:13 PM, Christian PERRIER wrote:
> (for dle readers: this package apparently violates many devref
> recommendations, particularly about debconf notes abuse. This is
> indeed a quite specific case, as the qmail package is used to generate
> qmail-src....many discussions already happened with the current
> maintainer about this. So, we'll not insist too hard on some things)
>
> Please find, for review, the debconf templates and packages descriptions for the qmail source package.
>
> This review will last from Monday, March 22, 2010 to Thursday, April 01, 2010.
>
> 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:
> --- qmail.old/debian/qmail.templates 2010-03-17 17:37:14.178507203 +0700
> +++ qmail/debian/qmail.templates 2010-03-22 23:23:43.122799848 +0700
> @@ -1,69 +1,77 @@
> Template: qmail/readme
> Type: note
> -_Description: README
> - Before making any changes to your qmail configuration, please read
> - /usr/share/doc/qmail/README.Debian.gz. This contains a description of the
> - differences bewtween other mailers on Debian, qmail on Debian, and qmail on
> - other systems.
> +_Description: Notice for qmail users
> + Before making any changes to Qmail configuration, please read
> + /usr/share/doc/qmail/README.Debian.gz. This file includes a
> + description of the differences between Qmail in Debian, Qmail in
> + other systems and other mail delivery agents.
> .
> If you were using sendmail (or smail) previously, you will also want to read
> the "qmail-upgrade" manpage, which details user-visible differences between
> sendmail and qmail.
> .
> If you are new to Qmail, you will want to at least peruse the Qmail FAQ, which
> - can be found in /usr/doc/qmail
> + can be found in /usr/share/doc/qmail.
>
> At least, let's give this template a decent synopsis. Otherwise, the
> template will look quite strange with some debonf interfaces (only
> "README" being displayed).
>
> In the first paragraph, I tried to make things clear that the
> document tries to explain what is specific with qmail in Debian, when
> compared *first* with qmail outside Debian and with other mail
> transport agents ("MTA" is used more often than "mailer" in most of
> our documents)
>
> Template: qmail/start
> -Type: select
> -_Choices: yes, no
> +Type: boolean
> _Description: Do you want to start qmail now?
>
> That could need code changes, but the use of "_Choices: yes, no"
> should disappear as it breaks consistency among packages (radio
> buttons for such questions instead of checkboxes.
>
> Template: qmail/reboot
> Type: note
> _Description: Qmail will be started at the next reboot
> - Or you can start qmail manually when
> - you are ready by typing (as root) "/etc/init.d/qmail start" at a shell prompt.
> + You did choose not to start qmail now. It will be started
> + automatically at next reboot.
> + .
> + You can also start it manually with "/etc/init.d/qmail start"
> + (as root) at a shell prompt.
>
> The long description should not be related to the synopsis and
> vice-versa.
>
> I did choose to make the template slightly more complete.
>
>
> Template: qmail/userpurge
> -Type: select
> -_Choices: yes, no
> +Type: boolean
> _Description: Remove qmail users during a purge?
> + Please choose whether you want users created by the qmail package
> + to be removed when this package is purged.
>
> Yet another template to turn into boolean.
>
> Adding a long description to give more details about what is prompted.
>
>
> Template: qmail/recipientmap
> -Type: note
> -_Description: WARNING
> +Type: error
> +_Description: Changes for virtual users
> recipientmap is gone from qmail-1.03. The virtualdomains mechanism
> - has been expanded to support virtual users. You will need to fix your setup.
> + has been expanded to support virtual users. This machine's setup
> + needs to be fixed.
>
> As above (first template), the synopsis really need to have more
> details (imagine such note popping up in the middle of installation of
> a dozen packages.....and, with the GNOME interface that only display
> the synopsis of notes (the long description appearing as a pop-up dialog).
>
>
> Template: qmail/qlist
> Type: note
> -_Description: WARNING
> - qlist has been split into a separate package by Dan Bernstein (the
> - author of qmail) since qmail-1.02.
> - .
> - qlist has not been packaged because ezmlm does a better job,
> - but if you still want qlist, you can either get it direct from
> - http://pobox.com/~djb/qlist.html
> +_Description: qlist utility discontinued
> + The qlist utility has been splitted into a separate package by upstream
> + developer since qmail 1.02.
> + .
> + This utility is not package as it can be replaced by ezmlm. It can
> + however be downloaded from http://pobox.com/~djb/qlist.html.
> .
> - Please check in /usr/doc/qmail and the man pages for changes since qmail 1.01
> + Please check in /usr/share/doc/qmail and the man pages for changes
> + since qmail 1.01.
>
> I wonder if this dialog is still useful given that qmail 1.03 seems to
> be around since 1999.
>
> So, I actually spent quite few time on it..:-)
>
> Just fixed a few leading capitals and reference to (very) obsolete /usr/doc
>
> Template: qmail/inetd
> -Type: note
> -_Description: inetd.conf changes
> - inetd does not handle qmail terribly effectively, so
> +Type: error
> +_Description: Internet superserver configuration file (inetd.conf) changes
> + The inetd superserver is not very efficient at handling qmail, so
> the default instalation uses tcpserver from ucspi-tcp instead.
> .
> For this reason, the smtp line in /etc/inetd.conf has been disabled.
> .
> This means that you must configure things such as RELAYCLIENT using
> - /etc/tcp.smtp, rather than hosts allow (see /usr/doc/qmail/README for details)
> + /etc/tcp.smtp, rather than hosts allow (see
> + /usr/share/doc/qmail/README for details).
>
> This template should probably be "Type: error" to get users'
> attention.
>
> A few reformulations and yet another occurrence of /usr/doc
>
> Template: qmail/tcpupdate
> Type: note
> _Description: Updating /etc/tcp.smtp database for tcpserver
>
> Template: qmail/override
> -Type: select
> -_Choices: yes, no
> -_Description: Pre-existing qmail installation detected. Override?
> -
> +Type: boolean
> +_Description: Override pre-existing qmail installation?
> + An existing installation of qmail has been detected. Please choose
> + whether you want this installation to be overriden.
> + .
> + Do not choose this option if you need to preserve the current setup
> + for qmail.
>
> And yet another "should be boolean".
>
> Oh, while at it: I also turned all occurrences of "qmail" to "Qmail"
> when reference is made to the software in general. I only left a
> lowercased qmail when the text makes a clear reference to the
> executable name.
>
> This is clear in the patch that's attached to this mail. I didn't
> change this above as I discovered these inconsistencies while writing
> these comments.
>
> --
>
>
> <qmail.templates><patch.rfr><control.txt>
Reply to: