Please find, for review, the debconf templates and packages descriptions for the tpconfig source package.
This review will last from Tuesday, December 09, 2008 to Friday, December 19, 2008.
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:
--- ../tpconfig.old/debian/templates 2008-12-09 08:52:15.469009135 +0100
+++ debian/templates 2008-12-09 18:41:27.716253117 +0100
@@ -1,9 +1,9 @@
Template: tpconfig/overwrite-config-file
Type: boolean
Default: true
-_Description: Manage tpconfig configuration file with debconf?
- The tpconfig configuration file, "/etc/default/tpconfig", can be handled
- automatically by debconf, or manually by you.
+_Description: Manage tpconfig configuration file automatically?
+ Please choose whether the tpconfig configuration file
+ (/etc/default/tpconfig) should be handled automatically or manually.
Direct reference to "debconf" is discouraged (See Developer's
Reference) as this is 'jargon' that might be non intelligible to
users.
The common way to ask such question is doing a reference to an
"automatic" configuration process.
Hence the rewording.
Template: tpconfig/reset_p
Type: boolean
@@ -11,15 +11,20 @@
_Description: Reset the touchpad when booting?
Some machines do not reset the touchpad hardware when they are booted
and/or resumed. On these machines, it is necessary to manually reset the
- touchpad. Accept here to do a manual reset when the system is started or
- resumed. Refuse if you don't want this.
+ touchpad.
+ .
+ If you choose this option, a manual reset will be performed when the
+ system is started or resumed.
Split in two paragraphs for better readability and to separate the two
ideas:
- the facts
- the options
To avoid making reference to "say yes" or such wording, which is
highly discouraged, the "If you choose this option, then <foo>"
wording is encouraged.
Template: tpconfig/options
Type: string
_Description: Options to pass to tpconfig when booting:
- Specify any command-line options you want passed to tpconfig at boot or
- resume time. (Note that if you specified above that the touchpad is to be
- reset, then it will be reset first, and then any options specified here
- done after.) For example, one common option is "--tapmode=0", which tells
- the touchpad to disable "tapping", to prevent spurious mouse events being
- caused by accidentally brushing against the touchpad.
+ Please specify any command-line options you want passed to tpconfig at
+ boot or resume time.
+ .
+ These options will be passed after the touchpad reset if you choosed
+ that option.
+ .
+ A common option is '--tapmode=0' which is meant to disable 'tapping'
+ in order to prevent spurious mouse events being caused by accidentally
+ brushing over the touchpad.
Split in 3 paragraphs for readability
"Please <foo>" is encouraged (overall consistency in writing style for
templates)
Avoid a full sentence in parenthesis, which looks ugly (not sure for
English, but in French, that's anyway typographycally incorrect).
"For example" is useless and does not fit the highly neutral wording
style we encourage.
Use single quotes (overall consistency among packages)
"brushing over the touchpad": I leave this to native speaker(s) to
decide if that' OK or not
--- ../tpconfig.old/debian/control 2008-12-09 08:52:15.465006895 +0100
+++ debian/control 2008-12-09 18:42:44.608400313 +0100
@@ -10,7 +10,7 @@
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Replaces: synaptics
-Description: configure touchpad devices
- This program can show or modify the configuration of several
- different kinds of touchpad devices, including the Synaptics
+Description: touchpad devices configuration utility
Avoid a verb sentence and make it a noun phrase
+ This package provides a program that can show or modify the configuration of
+ various touchpad devices, including the Synaptics
TouchPad and the ALPS Glidepad/Stickpointer.
We describe the package first...even if it only provides one program...:)
--
Template: tpconfig/overwrite-config-file Type: boolean Default: true _Description: Manage tpconfig configuration file automatically? Please choose whether the tpconfig configuration file (/etc/default/tpconfig) should be handled automatically or manually. Template: tpconfig/reset_p Type: boolean Default: false _Description: Reset the touchpad when booting? Some machines do not reset the touchpad hardware when they are booted and/or resumed. On these machines, it is necessary to manually reset the touchpad. . If you choose this option, a manual reset will be performed when the system is started or resumed. Template: tpconfig/options Type: string _Description: Options to pass to tpconfig when booting: Please specify any command-line options you want passed to tpconfig at boot or resume time. . These options will be passed after the touchpad reset if you choosed that option. . A common option is '--tapmode=0' which is meant to disable 'tapping' in order to prevent spurious mouse events being caused by accidentally brushing over the touchpad.
--- tpconfig.old/debian/templates 2008-12-09 08:52:15.469009135 +0100
+++ tpconfig/debian/templates 2008-12-09 18:45:43.336751841 +0100
@@ -1,25 +1,30 @@
Template: tpconfig/overwrite-config-file
Type: boolean
Default: true
-_Description: Manage tpconfig configuration file with debconf?
- The tpconfig configuration file, "/etc/default/tpconfig", can be handled
- automatically by debconf, or manually by you.
+_Description: Manage tpconfig configuration file automatically?
+ Please choose whether the tpconfig configuration file
+ (/etc/default/tpconfig) should be handled automatically or manually.
Template: tpconfig/reset_p
Type: boolean
Default: false
_Description: Reset the touchpad when booting?
Some machines do not reset the touchpad hardware when they are booted
- and/or resumed. On these machines, it is necessary to manually reset the
- touchpad. Accept here to do a manual reset when the system is started or
- resumed. Refuse if you don't want this.
+ and/or resumed. On these machines, it is necessary to manually reset the
+ touchpad.
+ .
+ If you choose this option, a manual reset will be performed when the
+ system is started or resumed.
Template: tpconfig/options
Type: string
_Description: Options to pass to tpconfig when booting:
- Specify any command-line options you want passed to tpconfig at boot or
- resume time. (Note that if you specified above that the touchpad is to be
- reset, then it will be reset first, and then any options specified here
- done after.) For example, one common option is "--tapmode=0", which tells
- the touchpad to disable "tapping", to prevent spurious mouse events being
- caused by accidentally brushing against the touchpad.
+ Please specify any command-line options you want passed to tpconfig at
+ boot or resume time.
+ .
+ These options will be passed after the touchpad reset if you choosed
+ that option.
+ .
+ A common option is '--tapmode=0' which is meant to disable 'tapping'
+ in order to prevent spurious mouse events being caused by accidentally
+ brushing over the touchpad.
--- tpconfig.old/debian/control 2008-12-09 08:52:15.465006895 +0100
+++ tpconfig/debian/control 2008-12-09 18:42:44.608400313 +0100
@@ -10,7 +10,7 @@
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Replaces: synaptics
-Description: configure touchpad devices
- This program can show or modify the configuration of several
- different kinds of touchpad devices, including the Synaptics
+Description: touchpad devices configuration utility
+ This package provides a program that can show or modify the configuration of
+ various touchpad devices, including the Synaptics
TouchPad and the ALPS Glidepad/Stickpointer.
Source: tpconfig
Section: utils
Priority: optional
Maintainer: Osamu Aoki <osamu@debian.org>
Uploaders: Chris Hanson <cph@debian.org>
Build-Depends: debhelper (>= 4.1.16), po-debconf
Standards-Version: 3.6.1
Package: tpconfig
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Replaces: synaptics
Description: touchpad devices configuration utility
This package provides a program that can show or modify the configuration of
various touchpad devices, including the Synaptics
TouchPad and the ALPS Glidepad/Stickpointer.
Attachment:
signature.asc
Description: Digital signature