Please find, for review, the debconf templates and packages descriptions for the adjtimex source package.
This review will last from Thursday, February 26, 2009 to Sunday, March 08, 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:
--- adjtimex.old/debian/templates 2009-02-17 19:47:33.908972952 +0100
+++ adjtimex/debian/templates 2009-02-22 07:55:52.961630293 +0100
@@ -2,21 +2,23 @@
Type: boolean
Default: true
_Description: Should adjtimex be run at installation and at every startup?
- adjtimex can run at system startup to set the kernel time parameters to
- the values in /etc/default/adjtimex. Don't accept if you just want to
+ It is possible to set the kernel time parameters to
+ the values in /etc/default/adjtimex by running adjtimex at system startup.
+ .
+ You should not choose this option if you just want to
use adjtimex to inspect the current parameters.
Avoid a leading lowercase letter in a sentence...by using passive
voice.
Replace "accept" by our currently suggested wording: "choose this option".
Template: adjtimex/compare_rtc
Type: boolean
Default: true
-_Description: Should adjtimexconfig be run when adjtimex is installed or upgraded?
+_Description: Run adjtimexconfig when adjtimex is installed or upgraded?
Shorten the sentence to give it a better chance to fit in one line,
including when translated.
The adjtimexconfig script will use adjtimex to find values for the kernel
variables tick and frequency that will make the system clock approximately
agree with the hardware clock (also known as the CMOS clock). It then
saves these values in the configuration file /etc/default/adjtimex so the
settings will be restored on every boot, when /etc/init.d/adjtimex runs.
.
- The script takes 70 sec to run. Alternatively, you can run adjtimexconfig
- yourself at a later time, or determine the kernel variables one of several
- other ways (see the adjtimex man page) and install them in
- /etc/default/adjtimex.
+ The script takes a significant time to run, so running it for every upgrade
+ may be a waste of time. Alternatively, you can run adjtimexconfig
+ manually when needed, or determine the kernel variables by using other
+ methods and set them manually in /etc/default/adjtimex.
*always exactly 70 seconds*? Let's be more vague...:-)...but more
precise about why we give the option (waste of time).
--- adjtimex.old/debian/control 2009-02-17 19:47:33.908972952 +0100
+++ adjtimex/debian/control 2009-02-22 07:57:34.609629557 +0100
@@ -9,12 +9,12 @@
Architecture: any
Depends: ${shlibs:Depends}, debconf | debconf-2.0
Suggests: ntpdate
-Description: Utility to display or set the kernel time variables
- This program gives you raw access to the kernel time variables. For
+Description: kernel time variables configuration utility
Avoid leading capital letter in packages' descriptions
My proposal is a pile of word....but puts the important information first....
+ This package provides a utility to manipulate the kernel time variables. For
Rather than "this program" (we install a package, not a program),
better use the commonly accept wording (this package provides...)
a machine connected to the Internet, or equipped with a precision
oscillator or radio clock, the best way to keep the system clock
- correct is with ntpd. However, for a standalone or intermittently
+ accurate is using NTP (Network Time Protocol). However, for a standalone or intermittently
connected machine, you may use adjtimex instead to at least correct
- for systematic drift. adjtimex can optionally adjust the system
+ for systematic drift. It can optionally adjust the system
clock using the CMOS clock as a reference, and can log times for
long-term estimation of drift rates.
s/correct/accurate
As there are several implementations of NTP, better talk about the
protocol and not one of the various daemons' name.....
Avoid starting a sentence with a lowercase letter...
--
Template: adjtimex/run_daemon Type: boolean Default: true _Description: Should adjtimex be run at installation and at every startup? It is possible to set the kernel time parameters to the values in /etc/default/adjtimex by running adjtimex at system startup. . You should not choose this option if you just want to use adjtimex to inspect the current parameters. Template: adjtimex/compare_rtc Type: boolean Default: true _Description: Run adjtimexconfig when adjtimex is installed or upgraded? The adjtimexconfig script will use adjtimex to find values for the kernel variables tick and frequency that will make the system clock approximately agree with the hardware clock (also known as the CMOS clock). It then saves these values in the configuration file /etc/default/adjtimex so the settings will be restored on every boot, when /etc/init.d/adjtimex runs. . The script takes a significant time to run, so running it for every upgrade may be a waste of time. Alternatively, you can run adjtimexconfig manually when needed, or determine the kernel variables by using other methods and set them manually in /etc/default/adjtimex.
--- adjtimex.old/debian/templates 2009-02-17 19:47:33.908972952 +0100
+++ adjtimex/debian/templates 2009-02-22 07:55:52.961630293 +0100
@@ -2,21 +2,23 @@
Type: boolean
Default: true
_Description: Should adjtimex be run at installation and at every startup?
- adjtimex can run at system startup to set the kernel time parameters to
- the values in /etc/default/adjtimex. Don't accept if you just want to
+ It is possible to set the kernel time parameters to
+ the values in /etc/default/adjtimex by running adjtimex at system startup.
+ .
+ You should not choose this option if you just want to
use adjtimex to inspect the current parameters.
Template: adjtimex/compare_rtc
Type: boolean
Default: true
-_Description: Should adjtimexconfig be run when adjtimex is installed or upgraded?
+_Description: Run adjtimexconfig when adjtimex is installed or upgraded?
The adjtimexconfig script will use adjtimex to find values for the kernel
variables tick and frequency that will make the system clock approximately
agree with the hardware clock (also known as the CMOS clock). It then
saves these values in the configuration file /etc/default/adjtimex so the
settings will be restored on every boot, when /etc/init.d/adjtimex runs.
.
- The script takes 70 sec to run. Alternatively, you can run adjtimexconfig
- yourself at a later time, or determine the kernel variables one of several
- other ways (see the adjtimex man page) and install them in
- /etc/default/adjtimex.
+ The script takes a significant time to run, so running it for every upgrade
+ may be a waste of time. Alternatively, you can run adjtimexconfig
+ manually when needed, or determine the kernel variables by using other
+ methods and set them manually in /etc/default/adjtimex.
--- adjtimex.old/debian/control 2009-02-17 19:47:33.908972952 +0100
+++ adjtimex/debian/control 2009-02-22 07:57:34.609629557 +0100
@@ -9,12 +9,12 @@
Architecture: any
Depends: ${shlibs:Depends}, debconf | debconf-2.0
Suggests: ntpdate
-Description: Utility to display or set the kernel time variables
- This program gives you raw access to the kernel time variables. For
+Description: kernel time variables configuration utility
+ This package provides a utility to manipulate the kernel time variables. For
a machine connected to the Internet, or equipped with a precision
oscillator or radio clock, the best way to keep the system clock
- correct is with ntpd. However, for a standalone or intermittently
+ accurate is using NTP (Network Time Protocol). However, for a standalone or intermittently
connected machine, you may use adjtimex instead to at least correct
- for systematic drift. adjtimex can optionally adjust the system
+ for systematic drift. It can optionally adjust the system
clock using the CMOS clock as a reference, and can log times for
long-term estimation of drift rates.
Source: adjtimex
Section: admin
Priority: optional
Maintainer: James R. Van Zandt <jrv@debian.org>
Build-Depends: debhelper (>= 5), po-debconf
Standards-Version: 3.8.0
Package: adjtimex
Architecture: any
Depends: ${shlibs:Depends}, debconf | debconf-2.0
Suggests: ntpdate
Description: kernel time variables configuration utility
This package provides a utility to manipulate the kernel time variables. For
a machine connected to the Internet, or equipped with a precision
oscillator or radio clock, the best way to keep the system clock
accurate is using NTP (Network Time Protocol). However, for a standalone or intermittently
connected machine, you may use adjtimex instead to at least correct
for systematic drift. It can optionally adjust the system
clock using the CMOS clock as a reference, and can log times for
long-term estimation of drift rates.
Attachment:
signature.asc
Description: Digital signature