Please find, for review, the debconf templates and packages descriptions for the uptimed source package.
This review will last from Monday, May 28, 2012 to Thursday, June 07, 2012.
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, a summary will be sent to the review bug report,
and a mail will be sent to this list with "[BTS]" as a subject tag.
Rationale:
--- uptimed.old/debian/uptimed.templates 2012-05-28 12:53:55.654480933 +0200
+++ uptimed/debian/uptimed.templates 2012-05-28 13:11:10.426311747 +0200
@@ -1,21 +1,21 @@
Template: uptimed/interval
Type: string
Default: 600
-_Description: Seconds that should pass between database updates:
- Uptimed will update its database every n seconds so that the uptime
+_Description: Delay between database updates (seconds):
+ Uptimed will update its database regularly so that the uptime
doesn't get lost in case of a system crash. You can set how frequently
this will happen (use higher values if you want to avoid disk activity,
- for example on a laptop). 60 seconds should be a reasonable default.
+ for instance on a laptop).
Change the synopsis to a more common writing style.
Avoid "every n seconds"
Drop the mention of a default as it is even not the default proposed
in Debian..:-)
Template: uptimed/maxrecords
Type: string
Default: 50
_Description: Number of records that should be kept:
- On systems that reboot frequently (such as desktop PCs), you will get a
+ On systems that reboot frequently, you will get a
fairly large list of uptime records pretty soon. To avoid this, uptimed
will only keep the n highest uptimes. You may want to limit this to a
lower value if you want to get emails each time a record is broken or
- reboot your machine often. 10 is a nice value.
+ reboot your machine often.
drop "such as desktop PCs". Most don't reboot that often and there are
numerous other examples anyway.
Drop the mention of the "nice value", which we don't use anyway as default..:)
Template: uptimed/mail/do_mail
Type: select
@@ -23,25 +23,23 @@
Default: Never
_Description: Send mails if a milestone or record is reached:
Uptimed can be configured to send a mail each time a record is broken or a
- "milestone" is reached. You can choose whether you
+ "milestone" is reached. You can choose whether you:
.
- - never want to receive these mails
- - want to be notified only when a record is broken
- - would like to know about milestones
- - are interested in both
+ - never want to receive these mails;
+ - want to be notified only when a record is broken;
+ - would like to know about milestones;
+ - are interested in both.
Standardize the enumeration...
Template: uptimed/mail/address
Type: string
Default: root
_Description: Uptimed emails recipient:
Since you have chosen to be sent emails, you should specify where to send
- these mails. The default "root@localhost" makes sort of sense, but if you
- are one of many sysadmins and you are unsure whether the other admins want
- to get these mails, you should probably set this to your real address.
+ these mails.
Simplfy things. Why need to explain why "root makes sense but also may
not make sense"....
Template: uptimed/mail/milestones_info
Type: note
-_Description: Milestone configuration should be done manually
- While all other configuration options can be set here, the milestones must
+_Description: Milestone configuration must be done manually
+ The milestones must
be configured manually in /etc/uptimed.conf. Since you have chosen to
- receive emails for milestones you may probably want to edit that file.
+ receive emails for milestones you may probably want to modify that file.
This note is debconf abuse (se debconf-devel(7) to learn why). If you
really insist on keeping it, here is a proposed rewrite.
--- uptimed.old/debian/control 2012-05-28 12:53:55.654480933 +0200
+++ uptimed/debian/control 2012-05-28 13:14:36.951790453 +0200
@@ -10,14 +10,14 @@
Architecture: any
Pre-Depends: ${misc:Pre-Depends}
Depends: ${misc:Depends}, ${shlibs:Depends}, lsb-base
-Description: Utility to track your highest uptimes
- Uptimed allows you to track your highest uptimes via boot IDs.
+Description :utility to track highest uptimes - daemon
+ Uptimed allows tracking highest uptimes via boot IDs.
It uses the system boot time to keep sessions apart from each
other.
.
Features:
- - Console program to display statistics
- - Can send mail if a milestone or a new record is reached
+ - Console program to display statistics;
+ - Can send mail if a milestone or a new record is reached.
Synopsis : standardize it with a common part for all binary packages
and a variable part.
Avoid personnalization. These are not "my" highest uptimes.
Standardize enumeration.
Package: libuptimed0
Section: libs
@@ -25,22 +25,26 @@
Depends: ${shlibs:Depends}, ${misc:Depends}, perl
Conflicts: libuptimed
Replaces: libuptimed
-Description: Library for uptimed
- Uptimed allows you to track your highest uptimes via boot IDs.
+Description: utility to track highest uptimes - library
+ Uptimed allows tracking highest uptimes via boot IDs.
+ It uses the system boot time to keep sessions apart from each
+ other.
.
Features:
- Console program to display statistics
- Can send mail if a milestone or a new record is reached
.
- This is the library package for uptimed
+ This package provides the library package for uptimed.
Standardize with a common part and a variable part.
Use standard "This package provides" wording.
Package: libuptimed-dev
Section: libdevel
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, perl, libuptimed0 (= ${binary:Version})
Replaces: libuptimed
-Description: Development files for uptimed
- Uptimed allows you to track your highest uptimes via boot IDs.
+Description: utility to track highest uptimes - development files
+ Uptimed allows tracking highest uptimes via boot IDs.
+ It uses the system boot time to keep sessions apart from each
+ other.
.
Features:
- Console program to display statistics
Again standardization
@@ -52,10 +56,10 @@
Architecture: all
Depends: uptimed (>= ${source:Version}), ${misc:Depends},
Recommends: apache | httpd
-Description: CGI script to show the world your highest uptimes
- This CGI script produces a HTML report containing all your
- highest uptimes from the uptimed database.
+Description: utility to track highest uptimes - CGI script
+ Uptimed allows tracking highest uptimes via boot IDs.
+ It uses the system boot time to keep sessions apart from each
+ other.
.
- Uptimed is a tool that allows you to track your highest uptimes
- via boot IDs. It uses the system boot time to keep sessions
- apart from each other.
+ This package provides a CGI script that produces an HTML report containing all
+ highest uptimes from the uptimed database.
Standardization again.
--
Template: uprecords-cgi/layout
Type: select
__Choices: pre, list, table
Default: pre
_Description: Format used by uprecords.cgi:
The uprecords CGI script has different ways of doing a proper display
layout. Which method you want to use depends mainly on your personal
preference. Available options are:
.
- pre: Encloses everything in <pre>...</pre>
- list: Makes a list, using <ol>...</ol>
- table: Creates an HTML table.
Template: uprecords-cgi/maxentries
Type: string
Default: 10
_Description: Number of records showed by uprecords.cgi:
While uptimed may keep a large number of uptime records, not all of them
are interesting to the outside world. Thus, you can limit the number of
records that will be shown here.
Template: uprecords-cgi/install_note
Type: note
_Description: uprecords.cgi has been installed into the webtree
You have installed the uprecords-cgi package. That means that a new CGI
script has been installed, which is now visible to the outside world as
http://${hostname}/cgi-bin/uprecords.cgi (if you didn't modify your
webserver configuration to have CGI scripts in a different place).
.
In the default webserver configuration, CGI scripts are accessible from
anywhere in the world. If you do not want this, you should set up access
restrictions (but who doesn't want to show off with his/her uptimes?).
.
You may also want to modify the HTML header and footer files in
/etc/uprecords-cgi or tell your webmaster to do so (remember to give him
the necessary permissions then).
Template: uptimed/interval Type: string Default: 600 _Description: Delay between database updates (seconds): Uptimed will update its database regularly so that the uptime doesn't get lost in case of a system crash. You can set how frequently this will happen (use higher values if you want to avoid disk activity, for instance on a laptop). Template: uptimed/maxrecords Type: string Default: 50 _Description: Number of records that should be kept: On systems that reboot frequently, you will get a fairly large list of uptime records pretty soon. To avoid this, uptimed will only keep the n highest uptimes. You may want to limit this to a lower value if you want to get emails each time a record is broken or reboot your machine often. Template: uptimed/mail/do_mail Type: select __Choices: Never, Record, Milestone, Both Default: Never _Description: Send mails if a milestone or record is reached: Uptimed can be configured to send a mail each time a record is broken or a "milestone" is reached. You can choose whether you: . - never want to receive these mails; - want to be notified only when a record is broken; - would like to know about milestones; - are interested in both. Template: uptimed/mail/address Type: string Default: root _Description: Uptimed emails recipient: Since you have chosen to be sent emails, you should specify where to send these mails. Template: uptimed/mail/milestones_info Type: note _Description: Milestone configuration must be done manually The milestones must be configured manually in /etc/uptimed.conf. Since you have chosen to receive emails for milestones you may probably want to modify that file.
--- uptimed.old/debian/uptimed.templates 2012-05-28 12:53:55.654480933 +0200
+++ uptimed/debian/uptimed.templates 2012-05-28 14:41:29.901791396 +0200
@@ -1,21 +1,21 @@
Template: uptimed/interval
Type: string
Default: 600
-_Description: Seconds that should pass between database updates:
- Uptimed will update its database every n seconds so that the uptime
+_Description: Delay between database updates (seconds):
+ Uptimed will update its database regularly so that the uptime
doesn't get lost in case of a system crash. You can set how frequently
this will happen (use higher values if you want to avoid disk activity,
- for example on a laptop). 60 seconds should be a reasonable default.
+ for instance on a laptop).
Template: uptimed/maxrecords
Type: string
Default: 50
_Description: Number of records that should be kept:
- On systems that reboot frequently (such as desktop PCs), you will get a
+ On systems that reboot frequently, you will get a
fairly large list of uptime records pretty soon. To avoid this, uptimed
will only keep the n highest uptimes. You may want to limit this to a
lower value if you want to get emails each time a record is broken or
- reboot your machine often. 10 is a nice value.
+ reboot your machine often.
Template: uptimed/mail/do_mail
Type: select
@@ -23,25 +23,23 @@
Default: Never
_Description: Send mails if a milestone or record is reached:
Uptimed can be configured to send a mail each time a record is broken or a
- "milestone" is reached. You can choose whether you
+ "milestone" is reached. You can choose whether you:
.
- - never want to receive these mails
- - want to be notified only when a record is broken
- - would like to know about milestones
- - are interested in both
+ - never want to receive these mails;
+ - want to be notified only when a record is broken;
+ - would like to know about milestones;
+ - are interested in both.
Template: uptimed/mail/address
Type: string
Default: root
_Description: Uptimed emails recipient:
Since you have chosen to be sent emails, you should specify where to send
- these mails. The default "root@localhost" makes sort of sense, but if you
- are one of many sysadmins and you are unsure whether the other admins want
- to get these mails, you should probably set this to your real address.
+ these mails.
Template: uptimed/mail/milestones_info
Type: note
-_Description: Milestone configuration should be done manually
- While all other configuration options can be set here, the milestones must
+_Description: Milestone configuration must be done manually
+ The milestones must
be configured manually in /etc/uptimed.conf. Since you have chosen to
- receive emails for milestones you may probably want to edit that file.
+ receive emails for milestones you may probably want to modify that file.
--- uptimed.old/debian/control 2012-05-28 12:53:55.654480933 +0200
+++ uptimed/debian/control 2012-05-28 14:45:39.228230248 +0200
@@ -10,14 +10,14 @@
Architecture: any
Pre-Depends: ${misc:Pre-Depends}
Depends: ${misc:Depends}, ${shlibs:Depends}, lsb-base
-Description: Utility to track your highest uptimes
- Uptimed allows you to track your highest uptimes via boot IDs.
+Description :utility to track highest uptimes - daemon
+ Uptimed allows tracking highest uptimes via boot IDs.
It uses the system boot time to keep sessions apart from each
other.
.
Features:
- - Console program to display statistics
- - Can send mail if a milestone or a new record is reached
+ - Console program to display statistics;
+ - Can send mail if a milestone or a new record is reached.
Package: libuptimed0
Section: libs
@@ -25,22 +25,26 @@
Depends: ${shlibs:Depends}, ${misc:Depends}, perl
Conflicts: libuptimed
Replaces: libuptimed
-Description: Library for uptimed
- Uptimed allows you to track your highest uptimes via boot IDs.
+Description: utility to track highest uptimes - library
+ Uptimed allows tracking highest uptimes via boot IDs.
+ It uses the system boot time to keep sessions apart from each
+ other.
.
Features:
- Console program to display statistics
- Can send mail if a milestone or a new record is reached
.
- This is the library package for uptimed
+ This package provides the library package for uptimed.
Package: libuptimed-dev
Section: libdevel
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, perl, libuptimed0 (= ${binary:Version})
Replaces: libuptimed
-Description: Development files for uptimed
- Uptimed allows you to track your highest uptimes via boot IDs.
+Description: utility to track highest uptimes - development files
+ Uptimed allows tracking highest uptimes via boot IDs.
+ It uses the system boot time to keep sessions apart from each
+ other.
.
Features:
- Console program to display statistics
@@ -52,10 +56,10 @@
Architecture: all
Depends: uptimed (>= ${source:Version}), ${misc:Depends},
Recommends: apache | httpd
-Description: CGI script to show the world your highest uptimes
- This CGI script produces a HTML report containing all your
- highest uptimes from the uptimed database.
+Description: utility to track highest uptimes - CGI script
+ Uptimed allows tracking highest uptimes via boot IDs.
+ It uses the system boot time to keep sessions apart from each
+ other.
.
- Uptimed is a tool that allows you to track your highest uptimes
- via boot IDs. It uses the system boot time to keep sessions
- apart from each other.
+ This package provides a CGI script that produces an HTML report containing all
+ highest uptimes from the uptimed database.
Source: uptimed
Section: utils
Priority: extra
Maintainer: Thibaut VARENE <varenet@debian.org>
Build-Depends: debhelper (>= 8.1.0~), dpkg-dev (>> 1.16.1~), automake, libtool, po-debconf
Standards-Version: 3.9.3
Homepage: http://podgorny.cz/uptimed
Package: uptimed
Architecture: any
Pre-Depends: ${misc:Pre-Depends}
Depends: ${misc:Depends}, ${shlibs:Depends}, lsb-base
Description :utility to track highest uptimes - daemon
Uptimed allows tracking highest uptimes via boot IDs.
It uses the system boot time to keep sessions apart from each
other.
.
Features:
- Console program to display statistics;
- Can send mail if a milestone or a new record is reached.
Package: libuptimed0
Section: libs
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, perl
Conflicts: libuptimed
Replaces: libuptimed
Description: utility to track highest uptimes - library
Uptimed allows tracking highest uptimes via boot IDs.
It uses the system boot time to keep sessions apart from each
other.
.
Features:
- Console program to display statistics
- Can send mail if a milestone or a new record is reached
.
This package provides the library package for uptimed.
Package: libuptimed-dev
Section: libdevel
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, perl, libuptimed0 (= ${binary:Version})
Replaces: libuptimed
Description: utility to track highest uptimes - development files
Uptimed allows tracking highest uptimes via boot IDs.
It uses the system boot time to keep sessions apart from each
other.
.
Features:
- Console program to display statistics
- Can send mail if a milestone or a new record is reached
.
This is the development files package for uptimed
Package: uprecords-cgi
Architecture: all
Depends: uptimed (>= ${source:Version}), ${misc:Depends},
Recommends: apache | httpd
Description: utility to track highest uptimes - CGI script
Uptimed allows tracking highest uptimes via boot IDs.
It uses the system boot time to keep sessions apart from each
other.
.
This package provides a CGI script that produces an HTML report containing all
highest uptimes from the uptimed database.
Attachment:
signature.asc
Description: Digital signature