Please find, for review, the debconf templates and packages descriptions for the ddclient source package.
This review will last from Monday, January 12, 2009 to Thursday, January 22, 2009.
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:
--- ../ddclient.old/debian/ddclient.templates 2009-01-07 09:01:35.082387030 +0100
+++ debian/ddclient.templates 2009-01-12 07:12:05.683663296 +0100
@@ -1,5 +1,6 @@
Template: ddclient/service
Type: select
+#flag:translate:5
__Choices: www.dyndns.com, www.easydns.com, www.dslreports.com, www.zoneedit.com, other
Default: www.dyndns.com
_Description: Dynamic DNS service provider:
Only mark "other" as translatable. That drops useless strings from PO
files.
However, you'll need to be careful later and remember changing "5"
into "6" if you add a new host to the list.
@@ -10,7 +11,7 @@
Template: ddclient/server
Type: string
_Description: Dynamic DNS server:
- Enter the name of the server which is providing you with dynamic DNS
+ Please enter the name of the server which is providing you with dynamic DNS
service (example: members.dyndns.org).
Use the common wording of "Please <foo>...."
Template: ddclient/protocol
@@ -18,37 +19,37 @@
Choices: dyndns2, dslreports1, easydns, hammernode1, zoneedit1, dyndns1
Default: dyndns2
_Description: Dynamic DNS update protocol:
- Select the dynamic DNS update protocol used by your dynamic DNS service
+ Please select the dynamic DNS update protocol used by your dynamic DNS service
provider.
Ditto
Template: ddclient/names
Type: string
_Description: DynDNS fully qualified domain names:
- Enter the list of fully qualified domain names for your host (like
- "myname.dyndns.org" if you have only one host or
+ Please enter the list of fully qualified domain names for the local host(s)
+ (for instance, "myname.dyndns.org" with only one host or
"myname1.dyndns.org,myname2.dyndns.org" for two hosts).
Ditto.
Use "for instance" instead of "like". Personal taste. This might be
better English, but Justin Rye will confirm...
Drop "if you have" to drop the concept of the user necessarily
"ownling" the machine(s).
Template: ddclient/username
Type: string
_Description: Username for dynamic DNS service:
- Enter the username you use to log into the dynamic DNS service.
+ Please enter the username to use with the dynamic DNS service.
"Please"....
"to use with": personal taste
Template: ddclient/password
Type: password
_Description: Password for dynamic DNS service:
- Enter the password you use to log into the dynamic DNS service.
+ Please enter the password to use with the dynamic DNS service.
Ditto
Template: ddclient/interface
Type: string
_Description: Network interface used for dynamic DNS service:
- Enter the name of the network interface (eth0/wlan0/ppp0/...) to use for
- dynamic DNS service.
+ Please enter the name of the network interface (eth0/wlan0/ppp0/...)
+ to use for dynamic DNS service.
Ditto
Template: ddclient/run_ipup
Type: boolean
Default: false
_Description: Run ddclient on PPP connect?
- Enable this if ddclient should be run every time a PPP connection is
+ You should enable this option if ddclient should be run every time a PPP connection is
established.
Avoid the use of imperative form.
Template: ddclient/run_daemon
@@ -61,16 +62,18 @@
Template: ddclient/daemon_interval
Type: string
Default: 300
-_Description: ddclient update interval:
+_Description: Daemon update interval:
Please choose the delay between interface address checks.
Values may be given in seconds (e.g. "5s"), in minutes (e.g. "3m"), in
hours (e.g. "7h") or in days (e.g. "1d").
Avoid the situation where we have a leading lowercase letter because
the first word is a program name.
Template: ddclient/modifiedconfig
-Type: note
+Type: error
_Description: Modified configuration file
The config file /etc/ddclient.conf on your system does not consist of
- three entries. The automatic configuration utility (debconf) cannot handle
- this. Maybe you modified the configuration file manually, thus it won't
- be modified. If you want a new config file to be created, please run
+ three entries. The automatic configuration utility cannot handle
+ this situation.
+ .
+ You may have edited the configuration file manually and it will not
+ be modified. If you need a new configuration file, please run
note->error (even if this is not strictly speaking an error, we want
the user's attention...also, the note will be displayed whatever
debconf setting is used, except "noninteractive")
Do not mention "debconf": this is discouraged in general.
Split in two paragraphs for readability.
Use "You mahe have edited" instead of "Maybe you modified": I find
this more colloquial.
"dpkg-reconfigure ddclient".
--- ../ddclient.old/debian/control 2009-01-07 09:01:35.082387030 +0100
+++ debian/control 2009-01-12 07:14:10.743664446 +0100
@@ -12,11 +12,14 @@
Depends: perl5, ${misc:Depends}, lsb-base (>= 3.1), initscripts (>= 2.86)
Recommends: libio-socket-ssl-perl
Provides: dyndns-client
-Description: Update IP addresses at dynamic DNS services
- A perl based client to update your dynamic IP address at DynDNS.com
- (or other dynamic DNS services such as Hammernode, Zoneedit or
- EasyDNS), thus allowing you and others to use a fixed hostname
- (myhost.dyndns.org) to access your machine. This client supports both
+Description: dynamic DNS services address updating utility
+ This package provides a client to update dynamic IP addresses with
+ several synamic DNS service providers, such at DynDNS.com.
+ .
+ This allows using a fixed hostname
+ (myhost.dyndns.org) to access a machine with a dynamic IP address.
+ .
+ This client supports both
the dynamic and (near) static services, MX setting, and alternative
- host. It caches the address, and only attempts the update if the
- address actually changes.
+ host. It caches the address, and only attempts the update when the
+ address changes.
Synopsis: avoid a sentence and start with a lowercase letter (see
recommendations in the DevRef)
Long description: split in paragraphs for readability
Use "This package provides" instead of an incomplete sentence with no
verb.
We don't care about the software being Perl or anything else. At least
this shouldn't be the first information given to users.
Avoid mentioning the various DynDNS services (they may change over
time) and only use DynDNS which is the "leader of the market")
Final sentence: simplify it, dropping the "actually" which I
personnally find to be used in any situation in current language,
which I find annoying (Justin wiill confirm or not).
--
Template: ddclient/service Type: select #flag:translate:5 __Choices: www.dyndns.com, www.easydns.com, www.dslreports.com, www.zoneedit.com, other Default: www.dyndns.com _Description: Dynamic DNS service provider: Please select the dynamic DNS service you are using. If the service you use is not listed, choose "other" and you will be asked for the protocol and the server name. Template: ddclient/server Type: string _Description: Dynamic DNS server: Please enter the name of the server which is providing you with dynamic DNS service (example: members.dyndns.org). Template: ddclient/protocol Type: select Choices: dyndns2, dslreports1, easydns, hammernode1, zoneedit1, dyndns1 Default: dyndns2 _Description: Dynamic DNS update protocol: Please select the dynamic DNS update protocol used by your dynamic DNS service provider. Template: ddclient/names Type: string _Description: DynDNS fully qualified domain names: Please enter the list of fully qualified domain names for the local host(s) (for instance, "myname.dyndns.org" with only one host or "myname1.dyndns.org,myname2.dyndns.org" for two hosts). Template: ddclient/username Type: string _Description: Username for dynamic DNS service: Please enter the username to use with the dynamic DNS service. Template: ddclient/password Type: password _Description: Password for dynamic DNS service: Please enter the password to use with the dynamic DNS service. Template: ddclient/interface Type: string _Description: Network interface used for dynamic DNS service: Please enter the name of the network interface (eth0/wlan0/ppp0/...) to use for dynamic DNS service. Template: ddclient/run_ipup Type: boolean Default: false _Description: Run ddclient on PPP connect? You should enable this option if ddclient should be run every time a PPP connection is established. Template: ddclient/run_daemon Type: boolean Default: false _Description: Run ddclient as daemon? Please choose whether you want ddclient to be run in daemon mode on system startup. Template: ddclient/daemon_interval Type: string Default: 300 _Description: Daemon update interval: Please choose the delay between interface address checks. Values may be given in seconds (e.g. "5s"), in minutes (e.g. "3m"), in hours (e.g. "7h") or in days (e.g. "1d"). Template: ddclient/modifiedconfig Type: error _Description: Modified configuration file The config file /etc/ddclient.conf on your system does not consist of three entries. The automatic configuration utility cannot handle this situation. . You may have edited the configuration file manually and it will not be modified. If you need a new configuration file, please run "dpkg-reconfigure ddclient".
--- ../ddclient.old/debian/ddclient.templates 2009-01-07 09:01:35.082387030 +0100
+++ debian/ddclient.templates 2009-01-12 07:12:05.683663296 +0100
@@ -1,5 +1,6 @@
Template: ddclient/service
Type: select
+#flag:translate:5
__Choices: www.dyndns.com, www.easydns.com, www.dslreports.com, www.zoneedit.com, other
Default: www.dyndns.com
_Description: Dynamic DNS service provider:
@@ -10,7 +11,7 @@
Template: ddclient/server
Type: string
_Description: Dynamic DNS server:
- Enter the name of the server which is providing you with dynamic DNS
+ Please enter the name of the server which is providing you with dynamic DNS
service (example: members.dyndns.org).
Template: ddclient/protocol
@@ -18,37 +19,37 @@
Choices: dyndns2, dslreports1, easydns, hammernode1, zoneedit1, dyndns1
Default: dyndns2
_Description: Dynamic DNS update protocol:
- Select the dynamic DNS update protocol used by your dynamic DNS service
+ Please select the dynamic DNS update protocol used by your dynamic DNS service
provider.
Template: ddclient/names
Type: string
_Description: DynDNS fully qualified domain names:
- Enter the list of fully qualified domain names for your host (like
- "myname.dyndns.org" if you have only one host or
+ Please enter the list of fully qualified domain names for the local host(s)
+ (for instance, "myname.dyndns.org" with only one host or
"myname1.dyndns.org,myname2.dyndns.org" for two hosts).
Template: ddclient/username
Type: string
_Description: Username for dynamic DNS service:
- Enter the username you use to log into the dynamic DNS service.
+ Please enter the username to use with the dynamic DNS service.
Template: ddclient/password
Type: password
_Description: Password for dynamic DNS service:
- Enter the password you use to log into the dynamic DNS service.
+ Please enter the password to use with the dynamic DNS service.
Template: ddclient/interface
Type: string
_Description: Network interface used for dynamic DNS service:
- Enter the name of the network interface (eth0/wlan0/ppp0/...) to use for
- dynamic DNS service.
+ Please enter the name of the network interface (eth0/wlan0/ppp0/...)
+ to use for dynamic DNS service.
Template: ddclient/run_ipup
Type: boolean
Default: false
_Description: Run ddclient on PPP connect?
- Enable this if ddclient should be run every time a PPP connection is
+ You should enable this option if ddclient should be run every time a PPP connection is
established.
Template: ddclient/run_daemon
@@ -61,16 +62,18 @@
Template: ddclient/daemon_interval
Type: string
Default: 300
-_Description: ddclient update interval:
+_Description: Daemon update interval:
Please choose the delay between interface address checks.
Values may be given in seconds (e.g. "5s"), in minutes (e.g. "3m"), in
hours (e.g. "7h") or in days (e.g. "1d").
Template: ddclient/modifiedconfig
-Type: note
+Type: error
_Description: Modified configuration file
The config file /etc/ddclient.conf on your system does not consist of
- three entries. The automatic configuration utility (debconf) cannot handle
- this. Maybe you modified the configuration file manually, thus it won't
- be modified. If you want a new config file to be created, please run
+ three entries. The automatic configuration utility cannot handle
+ this situation.
+ .
+ You may have edited the configuration file manually and it will not
+ be modified. If you need a new configuration file, please run
"dpkg-reconfigure ddclient".
--- ../ddclient.old/debian/control 2009-01-07 09:01:35.082387030 +0100
+++ debian/control 2009-01-12 07:14:10.743664446 +0100
@@ -12,11 +12,14 @@
Depends: perl5, ${misc:Depends}, lsb-base (>= 3.1), initscripts (>= 2.86)
Recommends: libio-socket-ssl-perl
Provides: dyndns-client
-Description: Update IP addresses at dynamic DNS services
- A perl based client to update your dynamic IP address at DynDNS.com
- (or other dynamic DNS services such as Hammernode, Zoneedit or
- EasyDNS), thus allowing you and others to use a fixed hostname
- (myhost.dyndns.org) to access your machine. This client supports both
+Description: dynamic DNS services address updating utility
+ This package provides a client to update dynamic IP addresses with
+ several synamic DNS service providers, such at DynDNS.com.
+ .
+ This allows using a fixed hostname
+ (myhost.dyndns.org) to access a machine with a dynamic IP address.
+ .
+ This client supports both
the dynamic and (near) static services, MX setting, and alternative
- host. It caches the address, and only attempts the update if the
- address actually changes.
+ host. It caches the address, and only attempts the update when the
+ address changes.
Source: ddclient
Section: net
Priority: extra
Maintainer: Torsten Landschoff <torsten@debian.org>
Uploaders: Marco Rodrigues <gothicx@sapo.pt>
Build-Depends: debhelper (>= 5), po-debconf, xmlto, quilt
Standards-Version: 3.7.2
Homepage: http://ddclient.sf.net
Package: ddclient
Architecture: all
Depends: perl5, ${misc:Depends}, lsb-base (>= 3.1), initscripts (>= 2.86)
Recommends: libio-socket-ssl-perl
Provides: dyndns-client
Description: dynamic DNS services address updating utility
This package provides a client to update dynamic IP addresses with
several synamic DNS service providers, such at DynDNS.com.
.
This allows using a fixed hostname
(myhost.dyndns.org) to access a machine with a dynamic IP address.
.
This client supports both
the dynamic and (near) static services, MX setting, and alternative
host. It caches the address, and only attempts the update when the
address changes.
Attachment:
signature.asc
Description: Digital signature