Re: request for feedback regarding package description
On 10/05/2010 01:38 PM, Justin B Rye wrote:
> Paul J Stevens wrote:
>> Package: dbmail
>> Priority: optional
>> Architecture: any
>> Pre-Depends: adduser
>> Depends: ${misc:Depends}, ${shlibs:Depends}, ucf (>= 0.30), debconf (>=
>> 0.5) | debconf-2.0
>> Provides: imap-server, pop3-server
>> Suggests: dbmail-pgsql | dbmail-mysql, sqlite3
>
> What no "Homepage:"?
It's is/was the source stanza. I'll add it to the main package as well.
>
>> Description: mail server that supports sql based mailstorage
>
> * Is it an MTA?
> * s/sql/SQL/
> * Useless use of "based"
> * Google says: "Did you mean: mail storage"
>
> How about:
>
> Description: email storage server that supports SQL
'supports' sounds a bit like an add-on optional thing. Point is it's
core! Apart from that, I'm happy with your improvement.
>> DBMAIL is a collection of programs that allows both users and email to
>> be stored in and retrieved from a relational database.
>> .
>> It supports MySQL, PostgreSQL and Sqlite3 as database backends. The
>> Sqlite3 backend, LDAP authentication and Sieve filtering are included
>> in the base package.
>> .
>> Supported client protocols are: POP3, IMAP4, LMTP, MANAGESIEVE.
>
> The canonical upstream capitalisation appears to be "DBMail" (and
> "ManageSieve").
ManageSieve is a protocol - not sure there's an RFC or whether it's
still in draft. Since IMAP4, SMTP, LMTP etc are always written in caps,
I selected to use the same in the package description. But I'll follow
your lead here. And you're right about the DBMail caps.
> I don't believe it allows users to be stored in a database. Maybe
> you mean something like:
Oops. Good point.
> DBMail is a collection of programs that allow the use of a relational
> database to store both email messages and user account data.
Great.
>> .
>> It supports MySQL, PostgreSQL and Sqlite3 as database backends. The
>> Sqlite3 backend, LDAP authentication and Sieve filtering are included
>> in the base package.
>> .
>> Supported client protocols are: POP3, IMAP4, LMTP, MANAGESIEVE.
>
> This is okay, though you might consider dividing it into a paragraph
> about DBMail in general and a paragraph about dbmail-base in
> particular (which varies for the other two packages):
>
> DBMail is a collection of programs that allow the use of a relational
> database to store both email messages and user account data. It
> supports Sieve filtering, and the client protocols POP3, IMAP4, LMTP,
> and ManageSieve.
> .
> This package supports LDAP authentication, with Sqlite3 as the
> database backend; see dbmail-pgsql and -mysql for alternatives.
>
> Then:
> Description: {Postgre,My}SQL module for DBMail
> DBMail is [...]
> .
> This package provides a module for adding {Postgre,My}SQL support.
Thanks.
--
________________________________________________________________
Paul Stevens paul at nfg.nl
NET FACILITIES GROUP GPG/PGP: 1024D/11F8CD31
The Netherlands________________________________http://www.nfg.nl
Reply to: