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

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



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

This review will last from Monday, February 21, 2011 to Thursday, March 03, 2011.

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:
--- prey.old/debian/templates	2011-02-13 11:18:29.483538793 +0100
+++ prey/debian/templates	2011-02-21 07:51:38.863056264 +0100
@@ -1,34 +1,45 @@
 Template: prey/reporting_frequency
 Type: string
 Default: 20
-_Description: Frequency of reports and actions:
- Number of minutes to wait before waking up Prey. Control Panel users can
- change this settings later on the web.
+_Description: Frequency of Prey reports and actions (minutes):
+ Please enter the time to wait before waking up Prey. Control Panel users can
+ change this setting later through the web interface.

Make the short description cleareer by re-mentioning the software
name.

Make sentences.
 
 Template: prey/active_modules
 Type: multiselect
 Choices: ${choices}
 Default: alarm
-_Description: Modules:
- Modules extend application functionality, there are two types of modules
- available: Report and Actions modules.
+_Description: Modules to activate:
+ Prey modules extend the application functionality either for
+ reports or actions.

Be clear about what we're asking: to activate modules.

  .
-  * network: collect information about the Internet connection.
-  * session: take a screenshot, collect information about modified files and running programs.
-  * webcam: try to take a picture using the webcam.
-  * geo: attempt lo geolocate the device by using its interal GPS or the nearest WiFi access points as reference.
-  * alarm: play a loud sound for 30 seconds.
-  * alert: show the thier a short message and optionally change the wallpaper.
-  * lock: lock the laptop from being used and ask for a password.
-  * secure: delete browser cookies and stored passwords.
+  * network: collects information about the Internet connection;
+  * session: takes a screenshot, collects information about modified
+             files and running programs;
+  * webcam : tries to take a picture using the webcam;
+  * geo    : attempts to geolocate the device by using its internal
+             GPS or the nearest WiFi access points as reference;
+  * alarm  : plays a loud sound for 30 seconds;
+  * alert  : shows the thier a short message and optionally change the
+             wallpaper;
+  * lock   : locks the laptop from being used and asks for a password;
+  * secure : deletes browser cookies and stored passwords.

Make the enumeration consistent: verbs at third person, semi-colons, alignment
 
 Template: prey/edit_config
 Type: note
-_Description: Finalize the configuration
- In order to finalize the configuration, it needs to choose which mode Prey should run in.
- This can be achieved by editing the file `/etc/prey/config' by hand, according to own preferences:
+_Description: Configuration finalization needed
+ In order to finalize the configuration, you need to choose Prey's
+ running mode.
  .
-  * Standalone: Reports are sent directly to the laptop's owner.
-    This requires user to activate Prey by generating/deleting a URL and set up a scp/sftp/mail server settings as well.
-  * Control Panel: Reports are sent to preyproject.com.
-    After obtaining an account at http://control.preyproject.com/signup users only need to set 'apt_key' and 'device_key' properly in the `/etc/prey/config' file.
+ This must be done by editing the "/etc/prey/config" file and choosing
+ among:
+ .
+  * Standalone   : reports are sent directly to the laptop's owner. This
+                   requires the user to activate Prey by
+                   generating/deleting a URL and setup either an scp,
+                   sftp or mail server.
+  * Control Panel: reports are sent to preyproject.com. After
+                   the creation of an account at 
+                   http://control.preyproject.com/signup, you need
+                   to set "apt_key" and "device_key" properly in
+                   the "/etc/prey/config" file.


I'm actually not happy *at all* with that template. I think it is
indeed debconf abuse.


Either this setting can be done by debconf and then the template
should be turned into a Select template.

Or this is a note saying that the software must be configured before
being run and this is debconf abuse..:-). Such notes belong to
README.Debian.

So, in the final proposed patch, I may very well turn the template in
a README.Debian file.

--- prey.old/debian/control	2011-02-13 11:18:29.483538793 +0100
+++ prey/debian/control	2011-02-21 07:52:44.199054803 +0100
@@ -26,10 +26,10 @@
 Recommends: python (>= 2.5),
  python-gtk2
 Description: utility for tracking stolen computers
- Prey is a lightweight program that will help you track and find your laptop if
+ Prey is a lightweight program that will help tracking and finding a laptop if
  it ever gets stolen.

Not only "you"..:)

  .
  Prey comprises a shell script which calls out on a regular basis to
- either a server run by prey project, or a url nominated by the system
- administrator. A graphical configuration tool is also provided which is
- used to maintain the simple config file.
+ either a server run by the Prey project, or a URL defined by the system
+ administrator. A graphical configuration tool is also provided in
+ order to maintain the simple config file.

Correct capitalization.

Style change

-- 


Template: prey/reporting_frequency
Type: string
Default: 20
_Description: Frequency of Prey reports and actions (minutes):
 Please enter the time to wait before waking up Prey. Control Panel users can
 change this setting later through the web interface.

Template: prey/active_modules
Type: multiselect
Choices: ${choices}
Default: alarm
_Description: Modules to activate:
 Prey modules extend the application functionality either for
 reports or actions.
 .
  * network: collects information about the Internet connection;
  * session: takes a screenshot, collects information about modified
             files and running programs;
  * webcam : tries to take a picture using the webcam;
  * geo    : attempts to geolocate the device by using its internal
             GPS or the nearest WiFi access points as reference;
  * alarm  : plays a loud sound for 30 seconds;
  * alert  : shows the thier a short message and optionally change the
             wallpaper;
  * lock   : locks the laptop from being used and asks for a password;
  * secure : deletes browser cookies and stored passwords.

Template: prey/edit_config
Type: note
_Description: Configuration finalization needed
 In order to finalize the configuration, you need to choose Prey's
 running mode.
 .
 This must be done by editing the "/etc/prey/config" file and choosing
 among:
 .
  * Standalone   : reports are sent directly to the laptop's owner. This
                   requires the user to activate Prey by
                   generating/deleting a URL and setup either an scp,
                   sftp or mail server.
  * Control Panel: reports are sent to preyproject.com. After
                   the creation of an account at 
                   http://control.preyproject.com/signup, you need
                   to set "apt_key" and "device_key" properly in
                   the "/etc/prey/config" file.
--- prey.old/debian/templates	2011-02-13 11:18:29.483538793 +0100
+++ prey/debian/templates	2011-02-21 07:51:38.863056264 +0100
@@ -1,34 +1,45 @@
 Template: prey/reporting_frequency
 Type: string
 Default: 20
-_Description: Frequency of reports and actions:
- Number of minutes to wait before waking up Prey. Control Panel users can
- change this settings later on the web.
+_Description: Frequency of Prey reports and actions (minutes):
+ Please enter the time to wait before waking up Prey. Control Panel users can
+ change this setting later through the web interface.
 
 Template: prey/active_modules
 Type: multiselect
 Choices: ${choices}
 Default: alarm
-_Description: Modules:
- Modules extend application functionality, there are two types of modules
- available: Report and Actions modules.
+_Description: Modules to activate:
+ Prey modules extend the application functionality either for
+ reports or actions.
  .
-  * network: collect information about the Internet connection.
-  * session: take a screenshot, collect information about modified files and running programs.
-  * webcam: try to take a picture using the webcam.
-  * geo: attempt lo geolocate the device by using its interal GPS or the nearest WiFi access points as reference.
-  * alarm: play a loud sound for 30 seconds.
-  * alert: show the thier a short message and optionally change the wallpaper.
-  * lock: lock the laptop from being used and ask for a password.
-  * secure: delete browser cookies and stored passwords.
+  * network: collects information about the Internet connection;
+  * session: takes a screenshot, collects information about modified
+             files and running programs;
+  * webcam : tries to take a picture using the webcam;
+  * geo    : attempts to geolocate the device by using its internal
+             GPS or the nearest WiFi access points as reference;
+  * alarm  : plays a loud sound for 30 seconds;
+  * alert  : shows the thier a short message and optionally change the
+             wallpaper;
+  * lock   : locks the laptop from being used and asks for a password;
+  * secure : deletes browser cookies and stored passwords.
 
 Template: prey/edit_config
 Type: note
-_Description: Finalize the configuration
- In order to finalize the configuration, it needs to choose which mode Prey should run in.
- This can be achieved by editing the file `/etc/prey/config' by hand, according to own preferences:
+_Description: Configuration finalization needed
+ In order to finalize the configuration, you need to choose Prey's
+ running mode.
  .
-  * Standalone: Reports are sent directly to the laptop's owner.
-    This requires user to activate Prey by generating/deleting a URL and set up a scp/sftp/mail server settings as well.
-  * Control Panel: Reports are sent to preyproject.com.
-    After obtaining an account at http://control.preyproject.com/signup users only need to set 'apt_key' and 'device_key' properly in the `/etc/prey/config' file.
+ This must be done by editing the "/etc/prey/config" file and choosing
+ among:
+ .
+  * Standalone   : reports are sent directly to the laptop's owner. This
+                   requires the user to activate Prey by
+                   generating/deleting a URL and setup either an scp,
+                   sftp or mail server.
+  * Control Panel: reports are sent to preyproject.com. After
+                   the creation of an account at 
+                   http://control.preyproject.com/signup, you need
+                   to set "apt_key" and "device_key" properly in
+                   the "/etc/prey/config" file.
--- prey.old/debian/control	2011-02-13 11:18:29.483538793 +0100
+++ prey/debian/control	2011-02-21 07:52:44.199054803 +0100
@@ -26,10 +26,10 @@
 Recommends: python (>= 2.5),
  python-gtk2
 Description: utility for tracking stolen computers
- Prey is a lightweight program that will help you track and find your laptop if
+ Prey is a lightweight program that will help tracking and finding a laptop if
  it ever gets stolen.
  .
  Prey comprises a shell script which calls out on a regular basis to
- either a server run by prey project, or a url nominated by the system
- administrator. A graphical configuration tool is also provided which is
- used to maintain the simple config file.
+ either a server run by the Prey project, or a URL defined by the system
+ administrator. A graphical configuration tool is also provided in
+ order to maintain the simple config file.
Source: prey
Section: utils
Priority: optional
Maintainer: Alessio Treglia <alessio@debian.org>
Build-Depends: debhelper (>= 7.0.50~),
 python (>= 2.5),
 python-support,
 po-debconf
Homepage: http://www.preyproject.com/
Standards-Version: 3.9.1
XS-Python-Version: >= 2.5
Vcs-Git: git://git.debian.org/git/collab-maint/prey.git
Vcs-Browser: http://git.debian.org/?p=collab-maint/prey.git

Package: prey
Architecture: all
Depends: openssl,
 imagemagick | scrot,
 bash (>= 4),
 curl,
 streamer,
 libio-socket-ssl-perl,
 libnet-ssleay-perl,
 ${perl:Depends},
 ${misc:Depends}
Recommends: python (>= 2.5),
 python-gtk2
Description: utility for tracking stolen computers
 Prey is a lightweight program that will help tracking and finding a laptop if
 it ever gets stolen.
 .
 Prey comprises a shell script which calls out on a regular basis to
 either a server run by the Prey project, or a URL defined by the system
 administrator. A graphical configuration tool is also provided in
 order to maintain the simple config file.

Attachment: signature.asc
Description: Digital signature


Reply to: