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

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



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

This review will last from Saturday, December 15, 2007 to Tuesday, December 25, 2007.

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:
--- ../calamaris.old/debian/templates	2007-12-01 12:53:01.362558809 +0530
+++ debian/templates	2007-12-10 00:55:17.670741579 +0530
@@ -1,100 +1,103 @@
 Template: calamaris/cache_type
 Type: select
-_Choices: auto, squid, oops
+__Choices: auto, squid, oops

Split out Choices to avoid translator's mistakes such as not putting
commas.

I usually recommend capitalizing choices in such cases but that would
require rewriting the maintainer scripts.

 Default: auto
-_Description: What type of proxy log files do you want to analyse?
+_Description: Type of proxy log files to analyse:

Do not ask questions for string templates. Cf DevRef

  Calamaris is able to process log files from Squid or Oops. If you choose
  'auto' it will look first for Squid log files and then for Oops log files.
  .
- 'auto' is a safe choice if you only have log files from one of them.
- Otherwise, you can force Calamaris here to use the correct log files.
+ Choosing 'auto' is recommended when only one proxy software is installed.
+ Otherwise, that setting can be enforced here.

Avoid leading lowercas letter. Otherwise reword for more neutral language.

 
 Template: calamaris/daily/task
 Type: select
-_Choices: nothing, mail, web, both
+__Choices: nothing, mail, web, both

Split choices

 Default: mail
-_Description: How should the daily analysis of Calamaris be stored?
+_Description: Storage method for Calamaris daily analysis reports:
  Calamaris is able to store the result of the analysis as an email sent to
- somebody or as a web page. You can also choose to not do an analysis at
- all or to do both.
+ a specified address or as a web page.
+ .
+ Please choose which of these methods you want to use.

s/somebody/a specified address: less vague

Split in paragraphes for readability and use the standard wording
"Please choose"

 
 Template: calamaris/daily/mail
 Type: string
 Default: root
-_Description: Email address to which the daily analysis should be sent
- If you chose to not do a daily analysis by email, then this value has no
- effect.
+_Description: Recipient for daily analysis reports by mail:
+ This setting is only useful if you activated the daily
+ analysis report to be sent by email.

Simplify wording

 
 Template: calamaris/daily/html
 Type: string
 Default: /var/www/calamaris/daily/index.html
-_Description: Where should the daily analysis be stored (in HTML)?
- If you chose to not do a daily analysis in HTML, then this value has no
- effect.
+_Description: Directory for storing HTML daily analysis reports:
+ Please choose the directory where generated HTML analysis reports will be
+ stored.

Avoid interrogative form.

Use standard "Please choose" wording
 
 Template: calamaris/daily/title
 Type: string
 _Default: Squid daily
-_Description: Title of the daily analysis
- You can enter arbitrary text here to prepend it to the title of the daily
- analysis.
+_Description: Title of the daily analysis reports:
+ Please choose the text that will be used as title for the daily
+ analysis reports.

The title stands for the report, not the analysis.

Similar changes for weekly and monthly reports...
 
--- ../calamaris.old/debian/control	2007-12-01 12:53:01.362558809 +0530
+++ debian/control	2007-12-14 11:13:01.669105590 +0530
@@ -13,14 +13,3 @@
  Calamaris is a Perl script which generates nice statistics out of
  Squid or Oops log files. It is invoked daily before the proxy rotates
  its log files and mails the statistics or puts them on the web.
- .
- There are quite a number of options to choose what kind of report
- should be generated (domain-report, peak-report, performance-report etc.).
- This can be tuned in /etc/calamaris/calamaris.conf and
- /etc/cron.daily/calamaris.
- .
- Advanced features can be used by installing libgd-graph-perl (graphics)
- or libnetaddr-ip-perl (IP address notation).
- .
- An example of such a report can be found on
- http://www.cord.de/tools/squid/calamaris/calamaris-3/

Most of things I suggest removing do pertain to a README.Debian file
rather than the package description, IMHO.

-- 


Template: calamaris/cache_type
Type: select
__Choices: auto, squid, oops
Default: auto
_Description: Type of proxy log files to analyse:
 Calamaris is able to process log files from Squid or Oops. If you choose
 'auto' it will look first for Squid log files and then for Oops log files.
 .
 Choosing 'auto' is recommended when only one proxy software is installed.
 Otherwise, that setting can be enforced here.

Template: calamaris/daily/task
Type: select
__Choices: nothing, mail, web, both
Default: mail
_Description: Storage method for Calamaris daily analysis reports:
 Calamaris is able to store the result of the analysis as an email sent to
 a specified address or as a web page.
 .
 Please choose which of these methods you want to use.

Template: calamaris/daily/mail
Type: string
Default: root
_Description: Recipient for daily analysis reports by mail:
 This setting is only useful if you activated the daily
 analysis report to be sent by email.

Template: calamaris/daily/html
Type: string
Default: /var/www/calamaris/daily/index.html
_Description: Directory for storing HTML daily analysis reports:
 Please choose the directory where generated HTML analysis reports will be
 stored.

Template: calamaris/daily/title
Type: string
_Default: Squid daily
_Description: Title of the daily analysis reports:
 Please choose the text that will be used as title for the daily
 analysis reports.

Template: calamaris/weekly/task
Type: select
_Choices: nothing, mail, web, both
Default: mail
_Description: Storage method for Calamaris weekly analysis reports:
 Calamaris is able to store the result of the analysis as an email sent to
 a specified address or as a web page.
 .
 Please choose which of these methods you want to use.

Template: calamaris/weekly/mail
Type: string
Default: root
_Description: Recipient for weekly analysis reports by mail:
 This setting is only useful if you activated the weekly
 analysis report to be sent by email.

Template: calamaris/weekly/html
Type: string
Default: /var/www/calamaris/weekly/index.html
_Description: Directory for storing HTML weekly analysis reports:
 Please choose the directory where generated HTML analysis reports will be
 stored.

Template: calamaris/weekly/title
Type: string
_Default: Squid weekly
_Description: Title of the weekly analysis reports:
 Please choose the text that will be used as title for the weekly
 analysis reports.

Template: calamaris/monthly/task
Type: select
_Choices: nothing, mail, web, both
Default: mail
_Description: Storage method for Calamaris monthly analysis reports:
 Calamaris is able to store the result of the analysis as an email sent to
 a specified address or as a web page.
 .
 Please choose which of these methods you want to use.

Template: calamaris/monthly/mail
Type: string
Default: root
_Description: Recipient for monthly analysis reports by mail:
 This setting is only useful if you activated the monthly
 analysis report to be sent by email.

Template: calamaris/monthly/html
Type: string
_Default: /var/www/calamaris/monthly/index.html
_Description: Directory for storing HTML monthly analysis reports:
 Please choose the directory where generated HTML analysis reports will be
 stored.

Template: calamaris/monthly/title
Type: string
_Default: Squid monthly
_Description: Title of the monthly analysis reports:
 Please choose the text that will be used as title for the monthly
 analysis reports.
--- ../calamaris.old/debian/templates	2007-12-01 12:53:01.362558809 +0530
+++ debian/templates	2007-12-10 00:55:17.670741579 +0530
@@ -1,100 +1,103 @@
 Template: calamaris/cache_type
 Type: select
-_Choices: auto, squid, oops
+__Choices: auto, squid, oops
 Default: auto
-_Description: What type of proxy log files do you want to analyse?
+_Description: Type of proxy log files to analyse:
  Calamaris is able to process log files from Squid or Oops. If you choose
  'auto' it will look first for Squid log files and then for Oops log files.
  .
- 'auto' is a safe choice if you only have log files from one of them.
- Otherwise, you can force Calamaris here to use the correct log files.
+ Choosing 'auto' is recommended when only one proxy software is installed.
+ Otherwise, that setting can be enforced here.
 
 Template: calamaris/daily/task
 Type: select
-_Choices: nothing, mail, web, both
+__Choices: nothing, mail, web, both
 Default: mail
-_Description: How should the daily analysis of Calamaris be stored?
+_Description: Storage method for Calamaris daily analysis reports:
  Calamaris is able to store the result of the analysis as an email sent to
- somebody or as a web page. You can also choose to not do an analysis at
- all or to do both.
+ a specified address or as a web page.
+ .
+ Please choose which of these methods you want to use.
 
 Template: calamaris/daily/mail
 Type: string
 Default: root
-_Description: Email address to which the daily analysis should be sent
- If you chose to not do a daily analysis by email, then this value has no
- effect.
+_Description: Recipient for daily analysis reports by mail:
+ This setting is only useful if you activated the daily
+ analysis report to be sent by email.
 
 Template: calamaris/daily/html
 Type: string
 Default: /var/www/calamaris/daily/index.html
-_Description: Where should the daily analysis be stored (in HTML)?
- If you chose to not do a daily analysis in HTML, then this value has no
- effect.
+_Description: Directory for storing HTML daily analysis reports:
+ Please choose the directory where generated HTML analysis reports will be
+ stored.
 
 Template: calamaris/daily/title
 Type: string
 _Default: Squid daily
-_Description: Title of the daily analysis
- You can enter arbitrary text here to prepend it to the title of the daily
- analysis.
+_Description: Title of the daily analysis reports:
+ Please choose the text that will be used as title for the daily
+ analysis reports.
 
 Template: calamaris/weekly/task
 Type: select
 _Choices: nothing, mail, web, both
 Default: mail
-_Description: How should the weekly analysis of Calamaris be stored?
+_Description: Storage method for Calamaris weekly analysis reports:
  Calamaris is able to store the result of the analysis as an email sent to
- somebody or as a web page. You can also choose to not do an analysis at
- all or to do both.
+ a specified address or as a web page.
+ .
+ Please choose which of these methods you want to use.
 
 Template: calamaris/weekly/mail
 Type: string
 Default: root
-_Description: Email address to which the weekly analysis should be sent
- If you chose to not do a weekly analysis by email, then this value has no
- effect.
+_Description: Recipient for weekly analysis reports by mail:
+ This setting is only useful if you activated the weekly
+ analysis report to be sent by email.
 
 Template: calamaris/weekly/html
 Type: string
 Default: /var/www/calamaris/weekly/index.html
-_Description: Where should the weekly analysis be stored (in HTML)?
- If you chose to not do a weekly analysis in HTML, then this value has no
- effect.
+_Description: Directory for storing HTML weekly analysis reports:
+ Please choose the directory where generated HTML analysis reports will be
+ stored.
 
 Template: calamaris/weekly/title
 Type: string
 _Default: Squid weekly
-_Description: Title of the weekly analysis
- You can enter arbitrary text here to prepend it to the title of the weekly
- analysis.
+_Description: Title of the weekly analysis reports:
+ Please choose the text that will be used as title for the weekly
+ analysis reports.
 
 Template: calamaris/monthly/task
 Type: select
 _Choices: nothing, mail, web, both
 Default: mail
-_Description: How should the monthly analysis of Calamaris be stored?
+_Description: Storage method for Calamaris monthly analysis reports:
  Calamaris is able to store the result of the analysis as an email sent to
- somebody or as a web page. You can also choose to not do an analysis at
- all or to do both.
+ a specified address or as a web page.
+ .
+ Please choose which of these methods you want to use.
 
 Template: calamaris/monthly/mail
 Type: string
 Default: root
-_Description: Email address to which the monthly analysis should be sent
- If you chose to not do a monthly analysis by email, then this value has no
- effect.
+_Description: Recipient for monthly analysis reports by mail:
+ This setting is only useful if you activated the monthly
+ analysis report to be sent by email.
 
 Template: calamaris/monthly/html
 Type: string
 _Default: /var/www/calamaris/monthly/index.html
-_Description: Where should the monthly analysis be stored (in HTML)?
- If you chose to not do a monthly analysis in HTML, then this value has no
- effect.
+_Description: Directory for storing HTML monthly analysis reports:
+ Please choose the directory where generated HTML analysis reports will be
+ stored.
 
 Template: calamaris/monthly/title
 Type: string
 _Default: Squid monthly
-_Description: Title of the monthly analysis
- You can enter arbitrary text here to prepend it to the title of the
- monthly analysis.
+_Description: Title of the monthly analysis reports:
+ Please choose the text that will be used as title for the monthly
+ analysis reports.
--- ../calamaris.old/debian/control	2007-12-01 12:53:01.362558809 +0530
+++ debian/control	2007-12-14 11:13:01.669105590 +0530
@@ -13,14 +13,3 @@
  Calamaris is a Perl script which generates nice statistics out of
  Squid or Oops log files. It is invoked daily before the proxy rotates
  its log files and mails the statistics or puts them on the web.
- .
- There are quite a number of options to choose what kind of report
- should be generated (domain-report, peak-report, performance-report etc.).
- This can be tuned in /etc/calamaris/calamaris.conf and
- /etc/cron.daily/calamaris.
- .
- Advanced features can be used by installing libgd-graph-perl (graphics)
- or libnetaddr-ip-perl (IP address notation).
- .
- An example of such a report can be found on
- http://www.cord.de/tools/squid/calamaris/calamaris-3/
Source: calamaris
Section: utils
Priority: optional
Maintainer: Philipp Frauenfelder <pfrauenf@debian.org>
Standards-Version: 3.7.2
Build-Depends-Indep: debhelper (>= 4.1.16), debconf, po-debconf

Package: calamaris
Architecture: all
Depends: perl5, bc, ${misc:Depends}
Suggests: squid (>= 1.1.0) | oops, libgd-graph-perl, libnetaddr-ip-perl
Description: log analyzer for Squid or Oops proxy log files
 Calamaris is a Perl script which generates nice statistics out of
 Squid or Oops log files. It is invoked daily before the proxy rotates
 its log files and mails the statistics or puts them on the web.

Attachment: signature.asc
Description: Digital signature


Reply to: