Please find, for review, the debconf templates and packages descriptions for the no-ip source package.
This review will last from Wednesday, September 12, 2007 to Saturday, September 22, 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:
--- ../no-ip.old/debian/templates 2007-09-08 08:54:32.445464795 +0200
+++ debian/templates 2007-09-08 09:01:47.421469328 +0200
@@ -1,30 +1,26 @@
Template: noip2/introduction
Type: note
-_Description: noip2 configuration data file
- noip2 uses a configuration data file that is stored by default on Debian
- systems as /etc/noip2.conf. This setup will help in setting up a
- configuration data file on your system.
+_Description: noip2 package configuration
+ The noip2 package uses a configuration data file named
+ /etc/noip2.conf. Further questions are meant to fill in settigns in that file.
.
- You will need to recreate the datafile whenever your account or password
- changes or when you add or delete hosts and/or groups at www.no-ip.com
- You can recreate the configuration data file by simply running the command
- .
- "dpkg-reconfigure noip2"
+ These settings must be updated whenever your account or password
+ changes or when you add or delete hosts and/or groups at
+ www.no-ip.com. This can be done by reconfiguring this package by
+ running 'dpkg-reconfigure noip2' as root.
OK, this template is definitely debconf abuse, which I reported as
#441279. Unfortunately, as I got no answer to this bug report, I have
no idea whether you agree or not and, in case, you stick with it, I
rewrote it anyway to the most acceptable option (but rewriting what I
consider useless verbiage is hard...)
So, well, changes becacuse:
-short description treated as a title
-avoid a sentence beginning by the program name and therefore not
using a capital letter
-"this setup" should never be mentioned in debconf templates. Never
make any reference to what is currently happening
-avoid the command to be alone on one paragraphr in an attempt to
shorten the note down
Template: noip2/username
Type: string
-_Description: No-IP.com username:
- Please enter your No-IP.com account username (usually your email address).
+_Description: No-IP.com user name:
+ Please enter your No-IP.com account user name (usually your email address).
s/username/user name
Template: noip2/password
Type: password
_Description: No-IP.com password:
- Please enter your No-IP.com account password.
The long description adds no value.
Template: noip2/updating
Type: string
Default: 30
_Description: Update interval (in minutes):
- Please enter the updating frequency (in minutes) you wish the
- noip2 client to use to update to your most current IP address. Press enter if
- you wish to use the default update interval of 30 minutes.
+ Please enter the updating frequency (in minutes) the noip2 client
+ should use to refresh the record of your IP address.
Better (more direct) wording, imho
--- ../no-ip.old/debian/control 2007-09-08 08:54:32.445464795 +0200
+++ debian/control 2007-09-08 09:03:31.915704899 +0200
@@ -12,12 +12,12 @@
Provides: no-ip
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: A second-generation Linux client for dynamic DNS service
- This is the No-IP.com Dynamic DNS update client.
+Description: client for dynamic DNS service
-no leading article
-"second generation" sounds amateurish and adds no information. Be
factual about what the program does
+ This package provides the No-IP.com Dynamic DNS update client.
Don't use "This is" in package description. The commonly accepted
wording is "This package provides"
.
- When configured correctly, the client will check your IP address at a
- given time interval checking to see if your IP has changed. If your
- IP address has changed it will notify our dns servers and update the
- IP corresponding to your No-IP/No-IP+ hostname.
+ When configured correctly, the client will check the local IP address at a
+ given time interval. If it
+ has changed, the client will notify NO-IP.com DNS servers and update the
+ IP address for your No-IP/No-IP+ host name.
Unpersonnalize by replacing "your IP address" (the address belongs to
the host, not me..:-))
Correct apitalization of "DNS"
Avoid "our" which, I guess, originates from the originally upstream
description but means nothing in the Debian context.
.
- Home Page: http://www.no-ip.com
+ Homepage: http://www.no-ip.com
Commonly accepted way to reference upstream's home page, waiting for
correct support of a "Homepage:" field in debian/control.
--
Template: noip2/introduction Type: note _Description: noip2 package configuration The noip2 package uses a configuration data file named /etc/noip2.conf. Further questions are meant to fill in settigns in that file. . These settings must be updated whenever your account or password changes or when you add or delete hosts and/or groups at www.no-ip.com. This can be done by reconfiguring this package by running 'dpkg-reconfigure noip2' as root. Template: noip2/username Type: string _Description: No-IP.com user name: Please enter your No-IP.com account user name (usually your email address). Template: noip2/password Type: password _Description: No-IP.com password: Template: noip2/updating Type: string Default: 30 _Description: Update interval (in minutes): Please enter the updating frequency (in minutes) the noip2 client should use to refresh the record of your IP address.
--- ../no-ip.old/debian/templates 2007-09-08 08:54:32.445464795 +0200
+++ debian/templates 2007-09-08 09:01:47.421469328 +0200
@@ -1,30 +1,26 @@
Template: noip2/introduction
Type: note
-_Description: noip2 configuration data file
- noip2 uses a configuration data file that is stored by default on Debian
- systems as /etc/noip2.conf. This setup will help in setting up a
- configuration data file on your system.
+_Description: noip2 package configuration
+ The noip2 package uses a configuration data file named
+ /etc/noip2.conf. Further questions are meant to fill in settigns in that file.
.
- You will need to recreate the datafile whenever your account or password
- changes or when you add or delete hosts and/or groups at www.no-ip.com
- You can recreate the configuration data file by simply running the command
- .
- "dpkg-reconfigure noip2"
+ These settings must be updated whenever your account or password
+ changes or when you add or delete hosts and/or groups at
+ www.no-ip.com. This can be done by reconfiguring this package by
+ running 'dpkg-reconfigure noip2' as root.
Template: noip2/username
Type: string
-_Description: No-IP.com username:
- Please enter your No-IP.com account username (usually your email address).
+_Description: No-IP.com user name:
+ Please enter your No-IP.com account user name (usually your email address).
Template: noip2/password
Type: password
_Description: No-IP.com password:
- Please enter your No-IP.com account password.
Template: noip2/updating
Type: string
Default: 30
_Description: Update interval (in minutes):
- Please enter the updating frequency (in minutes) you wish the
- noip2 client to use to update to your most current IP address. Press enter if
- you wish to use the default update interval of 30 minutes.
+ Please enter the updating frequency (in minutes) the noip2 client
+ should use to refresh the record of your IP address.
--- ../no-ip.old/debian/control 2007-09-08 08:54:32.445464795 +0200
+++ debian/control 2007-09-08 09:03:31.915704899 +0200
@@ -12,12 +12,12 @@
Provides: no-ip
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: A second-generation Linux client for dynamic DNS service
- This is the No-IP.com Dynamic DNS update client.
+Description: client for dynamic DNS service
+ This package provides the No-IP.com Dynamic DNS update client.
.
- When configured correctly, the client will check your IP address at a
- given time interval checking to see if your IP has changed. If your
- IP address has changed it will notify our dns servers and update the
- IP corresponding to your No-IP/No-IP+ hostname.
+ When configured correctly, the client will check the local IP address at a
+ given time interval. If it
+ has changed, the client will notify NO-IP.com DNS servers and update the
+ IP address for your No-IP/No-IP+ host name.
.
- Home Page: http://www.no-ip.com
+ Homepage: http://www.no-ip.com
Source: no-ip
Section: net
Priority: optional
Maintainer: Andres Mejia <mcitadel@gmail.com>, Otavio Salvador <otavio@debian.org>
Build-Depends: debhelper (>= 5), po-debconf, quilt
Standards-Version: 3.7.2
XS-Vcs-Git: git://git.debian.org/git/collab-maint/no-ip.git
XS-Vcs-Browser: http://git.debian.org/?p=collab-maint/no-ip.git
Package: noip2
Replaces: no-ip
Provides: no-ip
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: client for dynamic DNS service
This package provides the No-IP.com Dynamic DNS update client.
.
When configured correctly, the client will check the local IP address at a
given time interval. If it
has changed, the client will notify NO-IP.com DNS servers and update the
IP address for your No-IP/No-IP+ host name.
.
Homepage: http://www.no-ip.com
Attachment:
signature.asc
Description: Digital signature