[PKG-IRC-Maintainers] Bug#648241: [RFR] templates://ngircd/{ngircd.templates}

Christian PERRIER bubulle at debian.org
Fri Nov 18 06:20:28 UTC 2011 

Please find, for review, the debconf templates and packages descriptions for the ngircd source package.

This review will last from Friday, November 18, 2011 to Monday, November 28, 2011.

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, a summary will be sent to the review bug report,
and a mail will be sent to this list with "[BTS]" as a subject tag.

Rationale:
--- ngircd.old/debian/ngircd.templates	2011-11-09 22:27:17.300787539 +0100
+++ ngircd/debian/ngircd.templates	2011-11-14 07:27:55.252029366 +0100
@@ -2,22 +2,31 @@
 Type: boolean
 _Description: Convert ngIRCd configuration?
  In version 18, the ngIRCd configuration file format has changed.
- You can choose to have your configuration re-written.
- Don't worry, the old format is still supported.
+ .
+ You can choose to update the existing configuration or leave
+ it unmodified. The former configuration file format is still
+ supported.

We discourage anything that implies that the machine is "owned" by the
person doing the upgrade. Hence avoiding "your configuration".

Similarly, avoid addressing the user directly and use a more neutral wording.
 
 Template: ngircd/broken-oldconfig
 Type: text
-_Description: Cannot convert configuration
- The present configuration file contains errors and cannot
- be converted. Please check manually using
-    ngircd --configtest
- and run 'dpkg-reconfigure ngircd' to try again.
+_Description: Configuration conversion failure
+ The current configuration file contains errors and cannot
+ be converted. 
+ .
+ You should check the configuration file by running
+ "ngircd --configtest", fix errors and run "dpkg-reconfigure ngircd"
+ to retry the conversion process.

Shouldn't that be an "error" template?

Anyway, convert the short description to title-style instead of a
sentence.

Avoid hard-formatting in the middle of a paragraph. That's usually a
hassle for translators.

 
 Template: ngircd/conversion-fail
 Type: text
-_Description: Error
- Verification after conversion failed. This is a bug, please report it
- in the Debian bug tracker. Please include your configuration but make
- sure all passwords are removed.
- The diff below might give you some help:
-    ${DIFF}
+#flag:translate!:5
+_Description: Converted configuration file error
+ The converted configuration failed checks after conversion failed.
+ .
+ This should not happen and should therefore be reported as a bug.
+ Please include the configuration file in the bug report with
+ passwords removed.
+ .
+ The following difference file may help tracking this issue:
+ .
+  ${DIFF}

Here again, the template should maybe be "error" type. I actually
wonder why "text" is used bu haven't looked in details to the
maintainer scripts.

Make full sentences  and, again, avoid hard-formatting in the middle
of a paragraph.

Put the diff output on its own paragraph and make it non translatable.


--- ngircd.old/debian/control	2011-11-09 22:27:17.300787539 +0100
+++ ngircd/debian/control	2011-11-14 07:29:38.343649080 +0100
@@ -23,7 +23,7 @@
 Replaces: ircd
 Conflicts: dancer-ircd, ircd-hybrid, ircd-irc2, ircd-ircu, rageircd
 Homepage: http://ngircd.barton.de
-Description: Next generation IRC Server
- ngircd is a IRC Daemon for small or private networks. It does not contain all
- the functions like the professional ones, e.g services. It is written from
- scratch and is not based upon the original IRCd like many others.
+Description: yet another IRC Server
+ The ngircd daemon is an IRC server for small or private networks. It does
+ provide advanced features such as services. It is written from
+ scratch and is not based upon the original IRCd.

"next generation" will sound weird in 10 years..:-)

OK, my proposed short description is a little bit ironic. Feel free to
adapt it, but I would really recommend against "ng", even if that's in
the package name.

"*an* IRC server...or daemon" is recommended as this is the way it is
to be pronounced.

Avoid leading lowercase letter.

"e.g." is a latinism that should be avoided in English.

Avoid "like many others". It seems to imply that it is actually "bad"
to be based upon the original IRCd, which is not factual.

-- 


-------------- next part --------------
Template: ngircd/conversion-do
Type: boolean
_Description: Convert ngIRCd configuration?
 In version 18, the ngIRCd configuration file format has changed.
 .
 You can choose to update the existing configuration or leave
 it unmodified. The former configuration file format is still
 supported.

Template: ngircd/broken-oldconfig
Type: text
_Description: Configuration conversion failure
 The current configuration file contains errors and cannot
 be converted. 
 .
 You should check the configuration file by running
 "ngircd --configtest", fix errors and run "dpkg-reconfigure ngircd"
 to retry the conversion process.

Template: ngircd/conversion-fail
Type: text
#flag:translate!:5
_Description: Converted configuration file error
 The converted configuration failed checks after conversion failed.
 .
 This should not happen and should therefore be reported as a bug.
 Please include the configuration file in the bug report with
 passwords removed.
 .
 The following difference file may help tracking this issue:
 .
  ${DIFF}
-------------- next part --------------
--- ngircd.old/debian/ngircd.templates	2011-11-09 22:27:17.300787539 +0100
+++ ngircd/debian/ngircd.templates	2011-11-18 07:05:18.513807104 +0100
@@ -2,22 +2,31 @@
 Type: boolean
 _Description: Convert ngIRCd configuration?
  In version 18, the ngIRCd configuration file format has changed.
- You can choose to have your configuration re-written.
- Don't worry, the old format is still supported.
+ .
+ You can choose to update the existing configuration or leave
+ it unmodified. The former configuration file format is still
+ supported.
 
 Template: ngircd/broken-oldconfig
 Type: text
-_Description: Cannot convert configuration
- The present configuration file contains errors and cannot
- be converted. Please check manually using
-    ngircd --configtest
- and run 'dpkg-reconfigure ngircd' to try again.
+_Description: Configuration conversion failure
+ The current configuration file contains errors and cannot
+ be converted. 
+ .
+ You should check the configuration file by running
+ "ngircd --configtest", fix errors and run "dpkg-reconfigure ngircd"
+ to retry the conversion process.
 
 Template: ngircd/conversion-fail
 Type: text
-_Description: Error
- Verification after conversion failed. This is a bug, please report it
- in the Debian bug tracker. Please include your configuration but make
- sure all passwords are removed.
- The diff below might give you some help:
-    ${DIFF}
+#flag:translate!:5
+_Description: Converted configuration file error
+ The converted configuration failed checks after conversion failed.
+ .
+ This should not happen and should therefore be reported as a bug.
+ Please include the configuration file in the bug report with
+ passwords removed.
+ .
+ The following difference file may help tracking this issue:
+ .
+  ${DIFF}
--- ngircd.old/debian/control	2011-11-09 22:27:17.300787539 +0100
+++ ngircd/debian/control	2011-11-14 07:29:38.343649080 +0100
@@ -23,7 +23,7 @@
 Replaces: ircd
 Conflicts: dancer-ircd, ircd-hybrid, ircd-irc2, ircd-ircu, rageircd
 Homepage: http://ngircd.barton.de
-Description: Next generation IRC Server
- ngircd is a IRC Daemon for small or private networks. It does not contain all
- the functions like the professional ones, e.g services. It is written from
- scratch and is not based upon the original IRCd like many others.
+Description: yet another IRC Server
+ The ngircd daemon is an IRC server for small or private networks. It does
+ provide advanced features such as services. It is written from
+ scratch and is not based upon the original IRCd.
--- ngircd.old/debian/changelog	2011-11-09 22:27:17.300787539 +0100
+++ ngircd/debian/changelog	2011-11-10 07:05:55.007589207 +0100
@@ -1,3 +1,11 @@
+ngircd (18-2) UNRELEASED; urgency=low
+
+  * Debconf templates and debian/control reviewed by the debian-l10n-
+    english team as part of the Smith review project. Closes: #648241
+  * [Debconf translation updates]
+
+ -- Christian Perrier <bubulle at debian.org>  Thu, 10 Nov 2011 07:05:54 +0100
+
 ngircd (18-1) unstable; urgency=low
 
   * New upstream release 18
-------------- next part --------------
Source: ngircd
Section: net
Priority: optional
Maintainer: Debian IRC Team <pkg-irc-maintainers at lists.alioth.debian.org>
Uploaders: Mario Iseli <mario at debian.org>, Matt Arnold <mattarnold5 at gmail.com>,
    Christoph Biedl <debian.axhn at manchmal.in-ulm.de>
Build-Depends: debhelper (>= 7.0.50~),
    autotools-dev,
    expect,
    libgnutls-dev,
    po-debconf,
    procps,
    telnet,
Vcs-Svn: svn://svn.debian.org/pkg-irc/
Vcs-Browser: http://svn.debian.org/wsvn/pkg-irc
Standards-Version: 3.9.2

Package: ngircd
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, ${perl:Depends},
    debconf,
    lsb-base (>= 3.0-6),
Replaces: ircd
Conflicts: dancer-ircd, ircd-hybrid, ircd-irc2, ircd-ircu, rageircd
Homepage: http://ngircd.barton.de
Description: yet another IRC Server
 The ngircd daemon is an IRC server for small or private networks. It does
 provide advanced features such as services. It is written from
 scratch and is not based upon the original IRCd.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/pkg-irc-maintainers/attachments/20111118/3e44a309/attachment-0001.pgp>

More information about the Pkg-irc-maintainers mailing list