[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

[RFR] templates://hddtemp/{templates}



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

This review will last from Friday, January 11, 2008 to Monday, January 21, 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:
--- ../hddtemp.old/debian/templates	2007-12-20 05:54:16.106116830 +0100
+++ debian/templates	2008-01-10 06:58:54.107959338 +0100
@@ -1,52 +1,54 @@
 Template: hddtemp/SUID_bit
 Type: boolean
 Default: false
-_Description: Do you want /usr/sbin/hddtemp to be installed SUID root?
- You have the option of installing hddtemp with the SUID bit set.
+_Description: Should /usr/sbin/hddtemp be installed SUID root?
+ You have the option of installing hddtemp with the SUID bit set, allowing
+ it to be run and report the hard drives' temperature to regular users and
+ not only the superuser.

Unpersonnalize the question.

Merge with the explanations of the following paragraph and be clearer
about what "setuid" jargon and what it allows.


  .
- If you make hddtemp SUID, unprivileged users of your systems will be able
- to run it. This could, however, potentially allow hddtemp to be used
- during a security attack on  your computer. If in doubt, it is suggested 
- to install it without SUID. If you later change your mind, you can run:
- 'dpkg-reconfigure hddtemp'.
+ This could potentially allow hddtemp to be used during an attack
+ against the computer's security. If in doubt, do not choose this option.
+ .
+ This setting can be modified later by running 'dpkg-reconfigure hddtemp'.

Put the warning about security in its own paragraph for readability,
as well as the explanation about modifying this choice.

 
 Template: hddtemp/syslog
 Type: string
 Default: 0
-_Description: Interval between two checks:
- hddtemp can periodically log the temperature of the hard drive(s) via
- the SYSLOG interface.
+_Description: Interval between hard drive temperature checks:

Be clearer about *what* checks this i sabout..

+ The temperature of the hard drive(s) can be logged by hddtemp via
+ the generic system logging interface.

Use passive voice mostly to avoid the leading lowercase. Uncapitalize
"syslog" (this does not seem to be common rpactice to capitalize it).

  .
  Please enter a value in seconds corresponding to the interval between
- two checks. To disable this feature, simply enter 0.
+ two checks. To disable this feature, enter 0.

"simply" seems superfluous here.
 
 Template: hddtemp/daemon
 Type: boolean
 Default: false
-_Description: Do you want to start the hddtemp daemon on startup?
- hddtemp can be run as a daemon, listening on port 7634 for incoming
- connections. It is used some by software such as gkrellm to get
+_Description: Should the hddtemp daemon be started at boot?
+ The hddtemp program can be run as a daemon, listening on port 7634
+ for incoming connections. It is used some by software such as gkrellm to get
  the temperature of the hard drives.

Unpersonnalize the question. "at boot" may make it clearer than "on
startup" that this is about "system's boot".

Again, avoid a leading lowercase by using the "The <foo> program" trick.

  .
  You have the option of starting the hddtemp daemon automatically on the
  computer startup. If in doubt, it is suggested to not start it automatically
- on startup. If you later change your mind, you can run: 'dpkg-reconfigure
- hddtemp'.
+ on startup.
+ .
+ This setting can be modified later by running 'dpkg-reconfigure hddtemp'.

Move the suggestion about reconfiguring in its own paragrpah (avoids
duplicate translation work). This also avoids the "if you change your
mind" which (imho) sounds s spoken language rather than written.
 
 Template: hddtemp/interface
 Type: string
 Default: 127.0.0.1
 _Description: Interface to listen on:
- hddtemp can listen for incoming connections on a specific interface, or on 
- all interfaces. 
+ The hddtemp program can listen for incoming connections on a specific
+ interface, or on all interfaces. 

Un"leadinglowercase"

  .
  To listen on a specific interface, enter the IP address of that interface 
- (127.0.0.1 which is the default value corresponds to the lo interface). To 
- listen on all interfaces, simply enter 0.0.0.0.
+ (choosing 127.0.0.1 will accept local connections only). To listen on all interfaces,
+ enter 0.0.0.0.

Maybe no need to explain what 127.0.0.1 is....

Drop "simply", again.
 
 Template: hddtemp/port
 Type: string
 Default: 7634
 _Description: Port to listen on:
- By default, hddtemp listen for incoming connections on port 7634. However
- if you don't find this port appropriate, you can enter an other one.
+ By default, hddtemp listen for incoming connections on port 7634. This
+ can be changed for another port number.

That seems to be an evidence that changing the setting will happen
because the user does not think the default is appropriate..:)

--- ../hddtemp.old/debian/control	2007-12-20 05:54:16.106116830 +0100
+++ debian/control	2008-01-10 07:00:12.603767397 +0100
@@ -4,17 +4,14 @@
 Maintainer: Aurelien Jarno <aurel32@debian.org>
 Build-Depends: debhelper (>> 4.1.16), autotools-dev, gettext (>> 0.10.1)
 Standards-Version: 3.7.2
+Homepage: http://www.guzu.net/linux/hddtemp.php

New Homepage field
 
 Package: hddtemp
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, lsb-base (>= 3.0-3)
 Suggests: ksensors
 Conflicts: ksensors (<< 0.7-8), gkrellm-hddtemp (<< 0.1-9)
-Description: Utility to monitor the temperature of your hard drive
- hddtemp will give you the temperature of your PATA, SATA or SCSI hard 
- drive by reading Self-Monitoring Analysis and Reporting Technology 
- (S.M.A.R.T.) information (on drives that support this feature). Only 
- modern hard drives have a temperature sensor.  
- .
-  Author: Emmanuel Varagnat <hddtemp@guzu.net>
-  Homepage: http://www.guzu.net/linux/hddtemp.php
+Description: monitor hard drives temperature

"utility" is useless. Unpersonnalize: that's not necessarily "my" hard
drive

+ The hddtemp program monitors and reports the temperature of PATA, SATA
+ or SCSI hard drives by reading Self-Monitoring Analysis and Reporting
+ Technology (S.M.A.R.T.) information on drives that support this feature.

Un"leadinglowercase". Simplify the sentence.

"modern" is subjective and, moreover, that was probably true in the
20th century but, as of now, I guess that all HD support this.

The mention of the upstream author does not belong to debian/control, imho.

-- 


Template: hddtemp/SUID_bit
Type: boolean
Default: false
_Description: Should /usr/sbin/hddtemp be installed SUID root?
 You have the option of installing hddtemp with the SUID bit set, allowing
 it to be run and report the hard drives' temperature to regular users and
 not only the superuser.
 .
 This could potentially allow hddtemp to be used during an attack
 against the computer's security. If in doubt, do not choose this option.
 .
 This setting can be modified later by running 'dpkg-reconfigure hddtemp'.

Template: hddtemp/syslog
Type: string
Default: 0
_Description: Interval between hard drive temperature checks:
 The temperature of the hard drive(s) can be logged by hddtemp via
 the generic system logging interface.
 .
 Please enter a value in seconds corresponding to the interval between
 two checks. To disable this feature, enter 0.

Template: hddtemp/daemon
Type: boolean
Default: false
_Description: Should the hddtemp daemon be started at boot?
 The hddtemp program can be run as a daemon, listening on port 7634
 for incoming connections. It is used some by software such as gkrellm to get
 the temperature of the hard drives.
 .
 You have the option of starting the hddtemp daemon automatically on the
 computer startup. If in doubt, it is suggested to not start it automatically
 on startup.
 .
 This setting can be modified later by running 'dpkg-reconfigure hddtemp'.

Template: hddtemp/interface
Type: string
Default: 127.0.0.1
_Description: Interface to listen on:
 The hddtemp program can listen for incoming connections on a specific
 interface, or on all interfaces. 
 .
 To listen on a specific interface, enter the IP address of that interface 
 (choosing 127.0.0.1 will accept local connections only). To listen on all interfaces,
 enter 0.0.0.0.

Template: hddtemp/port
Type: string
Default: 7634
_Description: Port to listen on:
 By default, hddtemp listen for incoming connections on port 7634. This
 can be changed for another port number.
--- hddtemp.old/debian/templates	2007-12-20 05:54:16.106116830 +0100
+++ hddtemp/debian/templates	2008-01-11 07:24:59.064042483 +0100
@@ -1,52 +1,54 @@
 Template: hddtemp/SUID_bit
 Type: boolean
 Default: false
-_Description: Do you want /usr/sbin/hddtemp to be installed SUID root?
- You have the option of installing hddtemp with the SUID bit set.
+_Description: Should /usr/sbin/hddtemp be installed SUID root?
+ You have the option of installing hddtemp with the SUID bit set, allowing
+ it to be run and report the hard drives' temperature to regular users and
+ not only the superuser.
  .
- If you make hddtemp SUID, unprivileged users of your systems will be able
- to run it. This could, however, potentially allow hddtemp to be used
- during a security attack on  your computer. If in doubt, it is suggested 
- to install it without SUID. If you later change your mind, you can run:
- 'dpkg-reconfigure hddtemp'.
+ This could potentially allow hddtemp to be used during an attack
+ against the computer's security. If in doubt, do not choose this option.
+ .
+ This setting can be modified later by running 'dpkg-reconfigure hddtemp'.
 
 Template: hddtemp/syslog
 Type: string
 Default: 0
-_Description: Interval between two checks:
- hddtemp can periodically log the temperature of the hard drive(s) via
- the SYSLOG interface.
+_Description: Interval between hard drive temperature checks:
+ The temperature of the hard drive(s) can be logged by hddtemp via
+ the generic system logging interface.
  .
  Please enter a value in seconds corresponding to the interval between
- two checks. To disable this feature, simply enter 0.
+ two checks. To disable this feature, enter 0.
 
 Template: hddtemp/daemon
 Type: boolean
 Default: false
-_Description: Do you want to start the hddtemp daemon on startup?
- hddtemp can be run as a daemon, listening on port 7634 for incoming
- connections. It is used some by software such as gkrellm to get
+_Description: Should the hddtemp daemon be started at boot?
+ The hddtemp program can be run as a daemon, listening on port 7634
+ for incoming connections. It is used some by software such as gkrellm to get
  the temperature of the hard drives.
  .
  You have the option of starting the hddtemp daemon automatically on the
  computer startup. If in doubt, it is suggested to not start it automatically
- on startup. If you later change your mind, you can run: 'dpkg-reconfigure
- hddtemp'.
+ on startup.
+ .
+ This setting can be modified later by running 'dpkg-reconfigure hddtemp'.
 
 Template: hddtemp/interface
 Type: string
 Default: 127.0.0.1
 _Description: Interface to listen on:
- hddtemp can listen for incoming connections on a specific interface, or on 
- all interfaces. 
+ The hddtemp program can listen for incoming connections on a specific
+ interface, or on all interfaces. 
  .
  To listen on a specific interface, enter the IP address of that interface 
- (127.0.0.1 which is the default value corresponds to the lo interface). To 
- listen on all interfaces, simply enter 0.0.0.0.
+ (choosing 127.0.0.1 will accept local connections only). To listen on all interfaces,
+ enter 0.0.0.0.
 
 Template: hddtemp/port
 Type: string
 Default: 7634
 _Description: Port to listen on:
- By default, hddtemp listen for incoming connections on port 7634. However
- if you don't find this port appropriate, you can enter an other one.
+ By default, hddtemp listen for incoming connections on port 7634. This
+ can be changed for another port number.
--- hddtemp.old/debian/control	2007-12-20 05:54:16.106116830 +0100
+++ hddtemp/debian/control	2008-01-10 07:00:12.603767397 +0100
@@ -4,17 +4,14 @@
 Maintainer: Aurelien Jarno <aurel32@debian.org>
 Build-Depends: debhelper (>> 4.1.16), autotools-dev, gettext (>> 0.10.1)
 Standards-Version: 3.7.2
+Homepage: http://www.guzu.net/linux/hddtemp.php
 
 Package: hddtemp
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, lsb-base (>= 3.0-3)
 Suggests: ksensors
 Conflicts: ksensors (<< 0.7-8), gkrellm-hddtemp (<< 0.1-9)
-Description: Utility to monitor the temperature of your hard drive
- hddtemp will give you the temperature of your PATA, SATA or SCSI hard 
- drive by reading Self-Monitoring Analysis and Reporting Technology 
- (S.M.A.R.T.) information (on drives that support this feature). Only 
- modern hard drives have a temperature sensor.  
- .
-  Author: Emmanuel Varagnat <hddtemp@guzu.net>
-  Homepage: http://www.guzu.net/linux/hddtemp.php
+Description: monitor hard drives temperature
+ The hddtemp program monitors and reports the temperature of PATA, SATA
+ or SCSI hard drives by reading Self-Monitoring Analysis and Reporting
+ Technology (S.M.A.R.T.) information on drives that support this feature.
Source: hddtemp
Section: utils
Priority: extra
Maintainer: Aurelien Jarno <aurel32@debian.org>
Build-Depends: debhelper (>> 4.1.16), autotools-dev, gettext (>> 0.10.1)
Standards-Version: 3.7.2
Homepage: http://www.guzu.net/linux/hddtemp.php

Package: hddtemp
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, lsb-base (>= 3.0-3)
Suggests: ksensors
Conflicts: ksensors (<< 0.7-8), gkrellm-hddtemp (<< 0.1-9)
Description: monitor hard drives temperature
 The hddtemp program monitors and reports the temperature of PATA, SATA
 or SCSI hard drives by reading Self-Monitoring Analysis and Reporting
 Technology (S.M.A.R.T.) information on drives that support this feature.

Attachment: signature.asc
Description: Digital signature


Reply to: