[RFR] templates://cyrus-sasl2/{sasl2-bin.templates}

[Christian Perrier]

Please find, for review, the debconf templates and packages descriptions for the cyrus-sasl2 source package.

This review will last from Thursday, September 13, 2007 to Sunday, September 23, 2007.

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:

--- ../cyrus-sasl2.old/debian/sasl2-bin.templates	2007-09-09 08:15:44.523815127 +0200
+++ debian/sasl2-bin.templates	2007-09-09 08:26:08.992156746 +0200
@@ -2,12 +2,9 @@
 Type: boolean
 Default: false
 _Description: Remove /etc/sasldb2?
- Cyrus SASL can store usernames and passwords in the database file
- /etc/sasldb2. If you have stored important data in that file, then please
- make a backup now or choose not to remove the file.
- .
- If you have not stored important data in that file, it's safe to remove
- it.
+ Cyrus SASL can store user names and passwords in the /etc/sasldb2 database
+ file. If important data is stored in that file, you should back it up
+ now or choose not to remove the file.

s/username/user name

use "the <foo> file" construction

Unpersonnalize: replace "you have data in the file" by "data is in the
file"

Remove the second paragraph which is, imho, entirely useless: from
what we said in first, it should be obvious that it is safe to remove
the file if no important data is in it...:-)

 
 Template: cyrus-sasl2/backup-sasldb2
 Type: string
@@ -16,31 +13,37 @@
  Cyrus SASL has stored usernames and passwords in the database file
  /etc/sasldb2. That file has to be upgraded to a newer database
  format. Before doing that, the current file will be backed up.
- You can use that if you need to manually downgrade Cyrus SASL for
- some reason. Note that automatic downgrade is NOT SUPPORTED.
+ You can use that if you need to manually downgrade Cyrus SASL.
+ However, automatic downgrades are not supported.

More simpler and, imho, sufficient, wording.

Avoid shouting


  .
- Please specify the backup file name. The default is /var/backups/sasldb2.bak.
- Make sure you have enough free space in that location, and that a file
- with that name doesn't exist already. If it exists, it will be overwritten.
- An empty name selects the default.
+ Please specify the backup file name. You should check the available
+ disk space. If the backup file already exists, it will be overwritten.
+ Leaving this field empty will select the default value
+ (/var/backups/sasldb2.bak).

Specify the default file name when we specify that an empty answer
will select it: that simplfies the wording.
 
 Template: cyrus-sasl2/upgrade-sasldb2-backup-failed
-Type: note
-_Description: Failed to make backup of /etc/sasldb2
- For some reason, /etc/sasldb2 could not be backed up to the file you
- specified. This is a fatal error and will cause the package installation
+Type: error

"error" templates can now be used in such cases

+_Description: Failed to backup /etc/sasldb2

Make the template short description a title


+ The /etc/sasldb2 file could not be backed up with the file name you
+ specified.

Avoid "for some reason" that just means nothing. Just give facts

+ .
+ This is a fatal error and will cause the package installation
  to fail.
  .
  Please eliminate all possible reasons that might lead to this failure,
- such as exhausted disk space, and then try to configure this package again.
+ and try to configure this package again.

Just leave the local admin guesses about possible failure reasons as
we known there can be many of these.

 
 Template: cyrus-sasl2/upgrade-sasldb2-failed
-Type: note
+Type: error
 _Description: Failed to upgrade /etc/sasldb2
- For some reason, /etc/sasldb2 could not be upgraded to the new database
- format. This is a fatal error and will cause the package installation
- to fail. An attempt will be made to restore the backup of /etc/sasldb2 to
- its original location.
+ The /etc/sasldb2 file could not be upgraded to the new database
+ format.
+ .
+ This is a fatal error and will cause the package installation
+ to fail.
+ .
+ The configuration process will attempt to restore the backup of this
+ file to its original location.


About the same rationale than earlier template. Split in paragraphs
for readability.

  .
  Please eliminate all possible reasons that might lead to this failure,
- and then try to configure this package again.
+ and try to configure this package again.

"then" seems useless to me here

--- ../cyrus-sasl2.old/debian/control	2007-09-09 08:15:44.523815127 +0200
+++ debian/control	2007-09-09 08:31:21.977138950 +0200
@@ -12,7 +12,7 @@
 Priority: optional
 Architecture: any
 Depends: libsasl2-2 (>= 2.1.22.dfsg1-14), ${shlibs:Depends}, ${misc:Depends}, lsb-base (>= 3.0-6), db4.4-util
-Description: Administration programs for SASL users database
+Description: Cyrus SASL - administration programs for SASL users database

Use a"family description - package description" style all along binary
packages' descriptions.


No other change to debian/control...

-------------- next part --------------
Template: cyrus-sasl2/purge-sasldb2
Type: boolean
Default: false
_Description: Remove /etc/sasldb2?
 Cyrus SASL can store user names and passwords in the /etc/sasldb2 database
 file. If important data is stored in that file, you should back it up
 now or choose not to remove the file.

Template: cyrus-sasl2/backup-sasldb2
Type: string
Default: /var/backups/sasldb2.bak
_Description: Backup file name for /etc/sasldb2:
 Cyrus SASL has stored usernames and passwords in the database file
 /etc/sasldb2. That file has to be upgraded to a newer database
 format. Before doing that, the current file will be backed up.
 You can use that if you need to manually downgrade Cyrus SASL.
 However, automatic downgrades are not supported.
 .
 Please specify the backup file name. You should check the available
 disk space. If the backup file already exists, it will be overwritten.
 Leaving this field empty will select the default value
 (/var/backups/sasldb2.bak).

Template: cyrus-sasl2/upgrade-sasldb2-backup-failed
Type: error
_Description: Failed to backup /etc/sasldb2
 The /etc/sasldb2 file could not be backed up with the file name you
 specified.
 .
 This is a fatal error and will cause the package installation
 to fail.
 .
 Please eliminate all possible reasons that might lead to this failure,
 and try to configure this package again.

Template: cyrus-sasl2/upgrade-sasldb2-failed
Type: error
_Description: Failed to upgrade /etc/sasldb2
 The /etc/sasldb2 file could not be upgraded to the new database
 format.
 .
 This is a fatal error and will cause the package installation
 to fail.
 .
 The configuration process will attempt to restore the backup of this
 file to its original location.
 .
 Please eliminate all possible reasons that might lead to this failure,
 and try to configure this package again.
-------------- next part --------------
--- ../cyrus-sasl2.old/debian/sasl2-bin.templates	2007-09-09 08:15:44.523815127 +0200
+++ debian/sasl2-bin.templates	2007-09-09 08:26:08.992156746 +0200
@@ -2,12 +2,9 @@
 Type: boolean
 Default: false
 _Description: Remove /etc/sasldb2?
- Cyrus SASL can store usernames and passwords in the database file
- /etc/sasldb2. If you have stored important data in that file, then please
- make a backup now or choose not to remove the file.
- .
- If you have not stored important data in that file, it's safe to remove
- it.
+ Cyrus SASL can store user names and passwords in the /etc/sasldb2 database
+ file. If important data is stored in that file, you should back it up
+ now or choose not to remove the file.
 
 Template: cyrus-sasl2/backup-sasldb2
 Type: string
@@ -16,31 +13,37 @@
  Cyrus SASL has stored usernames and passwords in the database file
  /etc/sasldb2. That file has to be upgraded to a newer database
  format. Before doing that, the current file will be backed up.
- You can use that if you need to manually downgrade Cyrus SASL for
- some reason. Note that automatic downgrade is NOT SUPPORTED.
+ You can use that if you need to manually downgrade Cyrus SASL.
+ However, automatic downgrades are not supported.
  .
- Please specify the backup file name. The default is /var/backups/sasldb2.bak.
- Make sure you have enough free space in that location, and that a file
- with that name doesn't exist already. If it exists, it will be overwritten.
- An empty name selects the default.
+ Please specify the backup file name. You should check the available
+ disk space. If the backup file already exists, it will be overwritten.
+ Leaving this field empty will select the default value
+ (/var/backups/sasldb2.bak).
 
 Template: cyrus-sasl2/upgrade-sasldb2-backup-failed
-Type: note
-_Description: Failed to make backup of /etc/sasldb2
- For some reason, /etc/sasldb2 could not be backed up to the file you
- specified. This is a fatal error and will cause the package installation
+Type: error
+_Description: Failed to backup /etc/sasldb2
+ The /etc/sasldb2 file could not be backed up with the file name you
+ specified.
+ .
+ This is a fatal error and will cause the package installation
  to fail.
  .
  Please eliminate all possible reasons that might lead to this failure,
- such as exhausted disk space, and then try to configure this package again.
+ and try to configure this package again.
 
 Template: cyrus-sasl2/upgrade-sasldb2-failed
-Type: note
+Type: error
 _Description: Failed to upgrade /etc/sasldb2
- For some reason, /etc/sasldb2 could not be upgraded to the new database
- format. This is a fatal error and will cause the package installation
- to fail. An attempt will be made to restore the backup of /etc/sasldb2 to
- its original location.
+ The /etc/sasldb2 file could not be upgraded to the new database
+ format.
+ .
+ This is a fatal error and will cause the package installation
+ to fail.
+ .
+ The configuration process will attempt to restore the backup of this
+ file to its original location.
  .
  Please eliminate all possible reasons that might lead to this failure,
- and then try to configure this package again.
+ and try to configure this package again.
--- ../cyrus-sasl2.old/debian/control	2007-09-09 08:15:44.523815127 +0200
+++ debian/control	2007-09-09 08:31:21.977138950 +0200
@@ -12,7 +12,7 @@
 Priority: optional
 Architecture: any
 Depends: libsasl2-2 (>= 2.1.22.dfsg1-14), ${shlibs:Depends}, ${misc:Depends}, lsb-base (>= 3.0-6), db4.4-util
-Description: Administration programs for SASL users database
+Description: Cyrus SASL - administration programs for SASL users database
  This is the Cyrus SASL API implementation, version 2.1. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -23,7 +23,7 @@
 Section: doc
 Priority: optional
 Architecture: all
-Description: Documentation for Cyrus SASL library and utilities
+Description: Cyrus SASL - documentation
  This is the Cyrus SASL API implementation, version 2.1. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -36,15 +36,7 @@
 Conflicts: postfix (<< 2.3.4-3), libsasl2-gssapi-mit (<< 2.1.22), libsasl2-krb4-mit (<< 2.1.22)
 Recommends: libsasl2-modules (= ${binary:Version})
 Replaces: libsasl2
-Description: Authentication abstraction library
- SASL is the Simple Authentication and Security Layer, a method for
- adding authentication support to connection-based protocols. To use
- SASL, a protocol includes a command for identifying and
- authenticating a user to a server and for optionally negotiating
- protection of subsequent protocol interactions. If its use is
- negotiated, a security layer is inserted between the protocol and the
- connection. See RFC 2222 for more information.
- .
+Description: Cyrus SASL - authentication abstraction library
  This is the Cyrus SASL API implementation, version 2.1.
  .
  Any of: ANONYMOUS, CRAM-MD5, DIGEST-MD5, GSSAPI (MIT Kerberos 5 or MIT
@@ -58,7 +50,7 @@
 Architecture: any
 Depends: libsasl2-2 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
 Suggests: libsasl2-modules-otp, libsasl2-modules-ldap, libsasl2-modules-sql, libsasl2-modules-gssapi-mit | libsasl2-modules-gssapi-heimdal
-Description: Pluggable Authentication Modules for SASL
+Description: Cyrus SASL - pluggable authentication modules
  This is the Cyrus SASL API implementation, version 2.1. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -70,7 +62,7 @@
 Priority: optional
 Architecture: any
 Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
-Description: Pluggable Authentication Modules for SASL (LDAP)
+Description: Cyrus SASL - pluggable authentication modules (LDAP)
  This is the Cyrus SASL API implementation, version 2.1. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -82,7 +74,7 @@
 Architecture: any
 Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
 Conflicts: libsasl2-modules (<< 2.1.22~)
-Description: Pluggable Authentication Modules for SASL (OTP)
+Description: Cyrus SASL - pluggable authentication modules (OTP)
  This is the Cyrus SASL API implementation, version 2.1. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -93,7 +85,7 @@
 Priority: optional
 Architecture: any
 Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
-Description: Pluggable Authentication Modules for SASL (SQL)
+Description: Cyrus SASL - pluggable authentication modules (SQL)
  This is the Cyrus SASL API implementation, version 2.1. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -106,7 +98,7 @@
 Architecture: any
 Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
 Conflicts: libsasl2-modules-gssapi-heimdal
-Description: Pluggable Authentication Modules for SASL (GSSAPI)
+Description: Cyrus SASL - pluggable authentication modules (GSSAPI)
  This is the Cyrus SASL API implementation, version 2.1. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -120,7 +112,7 @@
 Depends: libsasl2-modules (= ${binary:Version}), libc6-dev
 Conflicts: libsasl2-2-dev
 Replaces: libsasl2-2-dev
-Description: Development files for SASL authentication abstraction library
+Description: Cyrus SASL - development files for authentication abstraction library
  This is the Cyrus SASL API implementation, version 2. See package
  libsasl2-2 and RFC 2222 for more information.
  .
@@ -132,7 +124,7 @@
 Architecture: any
 Priority: extra
 Depends: libsasl2-2 (= ${binary:Version})
-Description: Debugging symbols for Cyrus SASL
+Description: Cyrus SASL - debugging symbols
  This is the Cyrus SASL API implementation, version 2. See package
  libsasl2-2 and RFC 2222 for more information.
  .
-------------- next part --------------
Source: cyrus-sasl2
Section: libs
Priority: important
Maintainer: Debian Cyrus SASL Team <pkg-cyrus-sasl2-debian-devel at lists.alioth.debian.org>
Uploaders: Fabian Fagerholm <fabbe at debian.org>, Roberto C. Sanchez <roberto at connexer.com>
Standards-Version: 3.7.2
Build-Depends: debhelper (>= 5.0.0), dpatch, autotools-dev, automake1.9, autoconf, libtool, libdb4.4-dev (>= 4.4.16-2), libpam0g-dev (>= 0.76-22), libssl-dev (>= 0.9.7e-3), libmysqlclient15-dev (>= 5.0.20-1), libopie-dev (>= 2.32-10), libpq-dev (>= 8.1.3-4), libkrb5-dev, libsqlite0-dev (>= 2.8.16-1), libldap2-dev (>= 2.1.30-8), chrpath, groff-base, debconf (>= 0.5) | debconf-2.0, po-debconf, docbook-to-man
Build-Conflicts: heimdal-dev

Package: sasl2-bin
Section: utils
Priority: optional
Architecture: any
Depends: libsasl2-2 (>= 2.1.22.dfsg1-14), ${shlibs:Depends}, ${misc:Depends}, lsb-base (>= 3.0-6), db4.4-util
Description: Cyrus SASL - administration programs for SASL users database
 This is the Cyrus SASL API implementation, version 2.1. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package contains administration programs for the SASL users
 database and common binary files for plugin modules.    

Package: cyrus-sasl2-doc
Section: doc
Priority: optional
Architecture: all
Description: Cyrus SASL - documentation
 This is the Cyrus SASL API implementation, version 2.1. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package contains documentation for system administrators.

Package: libsasl2-2
Section: libs
Architecture: any
Depends: ${shlibs:Depends}
Conflicts: postfix (<< 2.3.4-3), libsasl2-gssapi-mit (<< 2.1.22), libsasl2-krb4-mit (<< 2.1.22)
Recommends: libsasl2-modules (= ${binary:Version})
Replaces: libsasl2
Description: Cyrus SASL - authentication abstraction library
 This is the Cyrus SASL API implementation, version 2.1.
 .
 SASL is the Simple Authentication and Security Layer, a method for
 adding authentication support to connection-based protocols. To use
 SASL, a protocol includes a command for identifying and
 authenticating a user to a server and for optionally negotiating
 protection of subsequent protocol interactions. If its use is
 negotiated, a security layer is inserted between the protocol and the
 connection. See RFC 2222 for more information.
 .
 Any of: ANONYMOUS, CRAM-MD5, DIGEST-MD5, GSSAPI (MIT Kerberos 5 or MIT
 Kerberos 5), NTLM, OTP, PLAIN, or LOGIN can be used. If you intend to use
 this package on a server that provides SASL authentication, then you must
 install some of the libsasl2-modules* packages.

Package: libsasl2-modules
Section: libs
Priority: optional
Architecture: any
Depends: libsasl2-2 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
Suggests: libsasl2-modules-otp, libsasl2-modules-ldap, libsasl2-modules-sql, libsasl2-modules-gssapi-mit | libsasl2-modules-gssapi-heimdal
Description: Cyrus SASL - pluggable authentication modules
 This is the Cyrus SASL API implementation, version 2.1. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package provides the following SASL modules: LOGIN, PLAIN, ANONYMOUS,
 NTLM, CRAM-MD5, and DIGEST-MD5 (with DES support).

Package: libsasl2-modules-ldap
Section: libs
Priority: optional
Architecture: any
Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
Description: Cyrus SASL - pluggable authentication modules (LDAP)
 This is the Cyrus SASL API implementation, version 2.1. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package provides the LDAP plugin, which supports OpenLDAP.

Package: libsasl2-modules-otp
Section: libs
Priority: optional
Architecture: any
Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
Conflicts: libsasl2-modules (<< 2.1.22~)
Description: Cyrus SASL - pluggable authentication modules (OTP)
 This is the Cyrus SASL API implementation, version 2.1. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package provides the OTP plugin, which supports one time passwords.

Package: libsasl2-modules-sql
Section: libs
Priority: optional
Architecture: any
Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
Description: Cyrus SASL - pluggable authentication modules (SQL)
 This is the Cyrus SASL API implementation, version 2.1. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package provides the SQL plugin, which supports MySQL, PostgreSQL
 and SQLite.

Package: libsasl2-modules-gssapi-mit
Section: libs
Priority: optional
Architecture: any
Depends: libsasl2-modules (= ${binary:Version}), ${shlibs:Depends}
Conflicts: libsasl2-modules-gssapi-heimdal
Description: Cyrus SASL - pluggable authentication modules (GSSAPI)
 This is the Cyrus SASL API implementation, version 2.1. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package provides the GSSAPI plugin, compiled with the MIT
 Kerberos 5 library.

Package: libsasl2-dev
Section: libdevel
Architecture: any
Priority: optional
Depends: libsasl2-modules (= ${binary:Version}), libc6-dev
Conflicts: libsasl2-2-dev
Replaces: libsasl2-2-dev
Description: Cyrus SASL - development files for authentication abstraction library
 This is the Cyrus SASL API implementation, version 2. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package includes development files for compiling programs with SASL
 support. It is needed for development purposes only.

Package: cyrus-sasl2-dbg
Section: libdevel
Architecture: any
Priority: extra
Depends: libsasl2-2 (= ${binary:Version})
Description: Cyrus SASL - debugging symbols
 This is the Cyrus SASL API implementation, version 2. See package
 libsasl2-2 and RFC 2222 for more information.
 .
 This package contains the debugging symbols for all Cyrus SASL packages.
 The debugging symbols can be useful when investigating crashes in the SASL
 library or tools. You may be asked to install this package if you encounter
 such a crash.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : http://lists.alioth.debian.org/pipermail/pkg-cyrus-sasl2-debian-devel/attachments/20070913/39a0ce74/attachment.pgp