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

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



Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

> +_Description: Type of proxy log files to analyse:

Commonly "analyze" in en_US.  That's never made any sense to me
(there's no zeta in the original Greek), but it would be consistent
with the "analyzer" in the package's short description.

> + Choosing 'auto' is recommended when only one proxy software is installed.

There's no such thing as one software; just drop the word and make
it "only one proxy".

> + Otherwise, that setting can be enforced here.

Readers are most likely to interpret "that setting" as "auto", and
get confused by the "otherwise", so say:

    Otherwise, the appropriate setting can be enforced here.

> +_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.

Throwing the data in the direction of an SMTP server is a strange
kind of "storage method", even if it does end up filed in the
webmaster's Gmail archives.  We could talk about "disposition
method", but that's too obscure.  Hmmm...

   _Description: Output method for Calamaris daily analysis reports:
    The result of the Calamaris analysis can be sent as an email to a
    specified address or stored as a web page.

>  Template: calamaris/daily/mail
> +_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.

I'm not sure about "activating" something to be done; and I'm
deliberately restoring some of the parallel phrasing in the
calamaris/*/mail and calamaris/*/html sets of templates.

    Please choose the address that should receive daily Calamaris analysis
    reports. This setting is only needed if the reports are to be sent by
    email.

>  Template: calamaris/daily/html
> +_Description: Directory for storing HTML daily analysis reports:
> + Please choose the directory where generated HTML analysis reports will be
> + stored.

    Please choose the directory where daily Calamaris analysis reports
    should be stored. This setting is only needed if the reports are to be
    generated as HTML.
  
>  Template: calamaris/daily/title
> - 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.

No, it said it's used as *part* of the title.  "Prepend" is an
obscure word, though...

    Please choose the text that will be used as a prefix to the title for
    the daily Calamaris analysis reports.

(Ditto weekly and monthly)

>  Package: calamaris
[...]
>  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.

This needs punctuation to reduce the likelihood that it will be
misinterpreted as "and [before the proxy] mails the statistics or
puts them on the web". 

    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.

The very first line of it might deserve to stay.  IMHO brief hints
about package relationships belong in the PD, since they're the sort
of information I want to get while I've got an aptitude session
open, rather than half an hour later when I realise that the manpage
was written for SuSE and go wading through /usr/share/doc/.  Boil it
down to: 

    Various options are supported for generated reports; some extra
    features require the suggested Perl modules.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../calamaris.old/debian/templates	2007-12-14 08:24:14.000000000 +0000
+++ debian/templates	2007-12-15 15:31:33.000000000 +0000
@@ -1,100 +1,109 @@
 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 analyze:
  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 is installed.
+ Otherwise, the appropriate 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?
- 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.
+_Description: Output method for Calamaris daily analysis reports:
+ The result of the Calamaris analysis can be sent as an email to a
+ specified address or stored 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:
+ Please choose the address that should receive daily Calamaris analysis
+ reports. This setting is only needed if the reports are 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 daily Calamaris analysis reports
+ should be stored. This setting is only needed if the reports are to be
+ generated as HTML.
 
 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 a prefix to the title for
+ the daily Calamaris 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?
- 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.
+_Description: Output method for Calamaris weekly analysis reports:
+ The result of the Calamaris analysis can be sent as an email to a
+ specified address or stored 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:
+ Please choose the address that should receive weekly Calamaris analysis
+ reports. This setting is only needed if the reports are 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 weekly Calamaris analysis reports
+ should be stored. This setting is only needed if the reports are to be
+ generated as HTML.
 
 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 a prefix to the title for
+ the weekly Calamaris 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?
- 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.
+_Description: Output method for Calamaris monthly analysis reports:
+ The result of the Calamaris analysis can be sent as an email to a
+ specified address or stored 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:
+ Please choose the address that should receive monthly Calamaris analysis
+ reports. This setting is only needed if the reports are 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.
+_Default: /var/www/calamaris/monthly/index.html
+_Description: Directory for storing HTML monthly analysis reports:
+ Please choose the directory where monthly Calamaris analysis reports
+ should be stored. This setting is only needed if the reports are to be
+ generated as HTML.
 
 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 a prefix to the title for
+ the monthly Calamaris analysis reports.
--- ../calamaris.old/debian/control	2007-12-14 08:24:14.000000000 +0000
+++ debian/control	2007-12-15 14:43:58.000000000 +0000
@@ -12,15 +12,7 @@
 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.
+ 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/
+ Various options are supported for generated reports; some extra
+ features require the suggested Perl modules.
Template: calamaris/cache_type
Type: select
__Choices: auto, squid, oops
Default: auto
_Description: Type of proxy log files to analyze:
 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 is installed.
 Otherwise, the appropriate setting can be enforced here.

Template: calamaris/daily/task
Type: select
__Choices: nothing, mail, web, both
Default: mail
_Description: Output method for Calamaris daily analysis reports:
 The result of the Calamaris analysis can be sent as an email to a
 specified address or stored 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:
 Please choose the address that should receive daily Calamaris analysis
 reports. This setting is only needed if the reports are 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 daily Calamaris analysis reports
 should be stored. This setting is only needed if the reports are to be
 generated as HTML.

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 a prefix to the title for
 the daily Calamaris analysis reports.

Template: calamaris/weekly/task
Type: select
_Choices: nothing, mail, web, both
Default: mail
_Description: Output method for Calamaris weekly analysis reports:
 The result of the Calamaris analysis can be sent as an email to a
 specified address or stored 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:
 Please choose the address that should receive weekly Calamaris analysis
 reports. This setting is only needed if the reports are 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 weekly Calamaris analysis reports
 should be stored. This setting is only needed if the reports are to be
 generated as HTML.

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 a prefix to the title for
 the weekly Calamaris analysis reports.

Template: calamaris/monthly/task
Type: select
_Choices: nothing, mail, web, both
Default: mail
_Description: Output method for Calamaris monthly analysis reports:
 The result of the Calamaris analysis can be sent as an email to a
 specified address or stored 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:
 Please choose the address that should receive monthly Calamaris analysis
 reports. This setting is only needed if the reports are 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 monthly Calamaris analysis reports
 should be stored. This setting is only needed if the reports are to be
 generated as HTML.

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 a prefix to the title for
 the monthly Calamaris analysis reports.
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.
 .
 Various options are supported for generated reports; some extra
 features require the suggested Perl modules.

Reply to: