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

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



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

This review will last from Thursday, October 25, 2007 to Sunday, November 04, 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:
--- ../analog.old/debian/templates	2007-10-14 09:36:16.534258735 +0200
+++ debian/templates	2007-10-21 14:03:28.821184638 +0200
@@ -2,6 +2,9 @@
 Type: boolean
 Default: false
 _Description: Enable the anlgform web interface to analog?
- Analog includes a cgi script called anlgform that provides a web interface
- to analog. It has a history of security problems, and may expose
- information (web site logs) that you don't want to make public.
+ Analog includes a CGI script called anlgform that provides a web interface
+ to the software.
+ .
+ Enabling it may have security implications and expose
+ informations, such as web site logs, that shouldn't be public.
+

Capitalize "CGI"

Avoid repetition of "analog"

Split in paragraphs for better readability.

The original wording is a bit scary and not really factual. I suggest
another wording which gives facts and does not talk about possible
"hidden" problems.


--- ../analog.old/debian/control	2007-10-14 09:36:16.534258735 +0200
+++ debian/control	2007-10-21 14:06:52.810682736 +0200
@@ -10,18 +10,17 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, perl
 Suggests: apache | httpd, rmagic
-Description: analyzes logfiles from web servers
- Analog is a fast logfile processor that generates usage statistic
- reports for your web server.
+Description: web server log files analyzer
+ Analog is a fast log file processor that generates usage statistic
+ reports for web servers.

Synopsis: don't make a sentence

s/logfile/log file

Unpersonnalize: remove "your"

  .
  Features:
-   * It's fast. Very fast. It can process millions of lines per minute.
-   * It's very scalable.
-   * It's very flexible. The default output will be satisfactory for
-     most people, but there are hundreds of options producing 32
-     different reports for those who want to do things differently.
-   * It can output in many different languages, and 4 output formats.
-   * It produces attractive output that complies with the HTML spec
-     (and so can be read on any browser).
-   * It can read logfiles in almost any format.
-   * It can be run at the command line or from a web form interface.
+  - Fast: can process millions of lines per minute;
+  - Scalable;
+  - Flexible: the default output is well suited for many needs
+    but etra options help producing 32 different report styles;
+  - Internationalized output;
+  - HTML output (compliant with standards);
+  - Handles many log file formats;
+  - Uses a command-line interface or a web interface.
+

I had hard times with this "feature" list.

This is indeed not a feature list but more an advertisement. So one
could argue that is doesn't belong to the package description.

I dropped the repetition of "It is" which doesn't bring anything.

-- 


Template: analog/anlgform
Type: boolean
Default: false
_Description: Enable the anlgform web interface to analog?
 Analog includes a CGI script called anlgform that provides a web interface
 to the software.
 .
 Enabling it may have security implications and expose
 informations, such as web site logs, that shouldn't be public.

--- ../analog.old/debian/templates	2007-10-14 09:36:16.534258735 +0200
+++ debian/templates	2007-10-21 14:03:28.821184638 +0200
@@ -2,6 +2,9 @@
 Type: boolean
 Default: false
 _Description: Enable the anlgform web interface to analog?
- Analog includes a cgi script called anlgform that provides a web interface
- to analog. It has a history of security problems, and may expose
- information (web site logs) that you don't want to make public.
+ Analog includes a CGI script called anlgform that provides a web interface
+ to the software.
+ .
+ Enabling it may have security implications and expose
+ informations, such as web site logs, that shouldn't be public.
+
--- ../analog.old/debian/control	2007-10-14 09:36:16.534258735 +0200
+++ debian/control	2007-10-21 14:06:52.810682736 +0200
@@ -10,18 +10,17 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, perl
 Suggests: apache | httpd, rmagic
-Description: analyzes logfiles from web servers
- Analog is a fast logfile processor that generates usage statistic
- reports for your web server.
+Description: web server log files analyzer
+ Analog is a fast log file processor that generates usage statistic
+ reports for web servers.
  .
  Features:
-   * It's fast. Very fast. It can process millions of lines per minute.
-   * It's very scalable.
-   * It's very flexible. The default output will be satisfactory for
-     most people, but there are hundreds of options producing 32
-     different reports for those who want to do things differently.
-   * It can output in many different languages, and 4 output formats.
-   * It produces attractive output that complies with the HTML spec
-     (and so can be read on any browser).
-   * It can read logfiles in almost any format.
-   * It can be run at the command line or from a web form interface.
+  - Fast: can process millions of lines per minute;
+  - Scalable;
+  - Flexible: the default output is well suited for many needs
+    but etra options help producing 32 different report styles;
+  - Internationalized output;
+  - HTML output (compliant with standards);
+  - Handles many log file formats;
+  - Uses a command-line interface or a web interface.
+
Source: analog
Section: web
Priority: optional
Build-Depends: debhelper (>= 5), libpcre3-dev, libz-dev, libjpeg-dev, libpng12-dev, libgd2-noxpm-dev (>= 2.0.1-18), libbz2-dev, dpkg-dev (>= 1.9.0)
Maintainer: Joey Hess <joeyh@debian.org>
Standards-Version: 3.7.2
XS-Vcs-Svn: svn://svn.kitenet.net/joey/trunk/src/packages/analog

Package: analog
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, perl
Suggests: apache | httpd, rmagic
Description: web server log files analyzer
 Analog is a fast log file processor that generates usage statistic
 reports for web servers.
 .
 Features:
  - Fast: can process millions of lines per minute;
  - Scalable;
  - Flexible: the default output is well suited for many needs
    but etra options help producing 32 different report styles;
  - Internationalized output;
  - HTML output (compliant with standards);
  - Handles many log file formats;
  - Uses a command-line interface or a web interface.

Attachment: signature.asc
Description: Digital signature


Reply to: