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

Re: [RFR] templates://netams/{netams.templates,netams-web.templates}



Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.
> 
> Rationale:
> --- netams.old/debian/netams.templates	2009-12-30 14:09:36.967745387 +0100
> +++ netams/debian/netams.templates	2009-12-30 19:50:35.612743440 +0100
[...]
>  Template: netams/admin-password
>  Type: password
>  _Description: NeTAMS administrator password:
> - Please enter password for "admin" user in NeTAMS database.
> + Please enter the password for the 'admin' user of NeTAMS.
> 
> Correct use of articles. Simple quotes (I have a doubt here as we
> didn't do reviews for quite a while: did we standardize on single or
> double quotes?).

Double; we've flip-flopped, but last I heard back in October we were
still preferring <">.  Steve Langasek likes them, for a start.

"Enter the password" might mean "guess the existing password"; this
is a case of "invent a new password", isn't it?  So say:

    Please specify a password for the "admin" user of NeTAMS.
  
> --- netams.old/debian/netams-web.templates	2009-12-30 14:09:36.971752261 +0100
> +++ netams/debian/netams-web.templates	2009-12-30 19:53:50.087745398 +0100
> @@ -3,4 +3,4 @@
>  Choices: apache2, lighttpd
>  _Description: Web server to reconfigure automatically:
>   Please choose the web server that should be automatically configured
> - to show NeTAMS webinterface.
> + for NeTAMS.
> 
> "webinterface" is not wished (more jargonic than correct English). In
> general, packages that are doing such prompting use the "configure for
> <foo>" style.

I was thinking "to run the NeTAMS web interface", but simplifying
works too.

> --- netams.old/debian/control	2009-12-30 14:09:36.963744870 +0100
> +++ netams/debian/control	2009-12-30 19:53:47.440753178 +0100
> @@ -13,9 +13,9 @@
>  Depends: ${shlibs:Depends}, ${misc:Depends}, dbconfig-common, lsb-base, dbconfig-common, lsb-base
>  Recommends: netams-web, apache2|lighttpd|httpd
>  Suggests: mysql-server|postgresql
> -Description: Network Traffic Accounting and Monitoring Software
> +Description: network traffic accounting and monitoring
> 
> Even though the capitals are a way to relate the package acronym to
> its meaning, it is quite ugly in a short description. Also,
> "software", here, is discouraged.
> 
> Moreover, we explain the acronym later on so we can just drop the capitals.

Unfortunately once you take away this phrase's claim to represent an
explanation of "Ne.T.A.M.S.", it becomes a rather poor description
of the package.  NeTAMS isn't network traffic accounting and
monitoring; it's a piece of software (a daemon, to be specific) that
_performs_ network traffic accounting and monitoring.  Maybe the
appropriate fix is just to make it:

   Description: network traffic accounting and monitoring daemon
 
>   NeTAMS stands for Network Traffic Accounting and Monitoring Software.
> - It is built for UNIX and works for networks with Cisco routers or PC Unix
> + It works for networks with Cisco routers or Unix-based
> 
> We provide the software in a Unix-like environment (Debian) so no need
> to explain that the software is for Unix..:-)
> 
> The routers are not necessarily PCs. They can be Sun machines, or the
> various diskless stuff such as NSLU2....

I would also be inclined to demote this information about what kinds
of hardware NeTAMS works with, and move the stuff about collecting
statistics up to take its place.
 
>   routers (Linux/FreeBSD/Solaris). Several methods of traffic gathering are
>   supported (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph),
>   database storage (BerkleyDB/MySQL/PostgresSQL/Oracle/Radius), aggregation,
                      Berkeley DB                        RADIUS
>   visualization, notification etc.

This sentence needs a little work; it starts with passive "these are
supported" but then carries on as if it had said "it supports
several methods of...". 

>                                    It is possible to block traffic based on
>   quotas, web authorization, account balance (billing); manage bandwidth, MAC
>   assignmant violations, RADIUS services, create a flexible accounting and
    assignment
>   filtering policies.

That's "MAC address assignmEnt".  But hang on, what is a network
traffic monitoring daemon doing "assigning" MAC addresses?  Does it
just mean that NeTAMS can do MAC address accounting/filtering?  And
if so, would it be better listed among the blocking criteria in the
previous clause?

So maybe:

  NeTAMS stands for Network Traffic Accounting and Monitoring Software.
  It supports several mechanisms for traffic statistics gathering
  (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph), database
  storage (Berkeley DB/MySQL/PostgresSQL/Oracle/RADIUS), aggregation,
  visualization, notification, etcetera, and works for networks with
  either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can block
  traffic based on quotas, web authorization, MAC address, or account
  balance (billing); manage bandwidth, or RADIUS services; and create
  flexible accounting and filtering policies.

Or making things vaguer (but I use the above version in my patch):

  either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can
  manage traffic based on quotas, web authorization, MAC address,
  bandwidth, RADIUS services, or account balance (billing); and can
  create flexible accounting and filtering policies.

Input welcome from those who aren't just guessing.

[...]
>  Package: netams-dbg          
[...]
> +Description: debug symbols for NeTAMS
[...]
> + This package provides NetAMS debugging symbols.
                          NeTAMS
I'd also suggest:

>  Package: netams-web
[...]
>  Description: NetAMS's web-interface
                web interface for NeTAMS
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
Template: netams/reconfigure-webserver
Type: multiselect
Choices: apache2, lighttpd
_Description: Web server to reconfigure automatically:
 Please choose the web server that should be automatically configured
 for NeTAMS statistics.

Template: netams/admin-password
Type: password
_Description: NeTAMS administrator password:
 Please specify a password for the "admin" user of NeTAMS.

Template: netams/admin-password-again
Type: password
_Description: NeTAMS administrator password confirmation:

Template: netams/password-mismatch
Type: error
_Description: Password mismatch
 The two passwords you entered were not the same. Please enter a password
 again.

Template: netams/password-empty
Type: error
_Description: Empty password
 You entered an empty password, which is not allowed. Please choose a non-
 empty password.
Template: netams-web/reconfigure-webserver
Type: multiselect
Choices: apache2, lighttpd
_Description: Web server to reconfigure automatically:
 Please choose the web server that should be automatically configured
 for NeTAMS.
Source: netams
Section: net
Priority: optional
Maintainer: Alexander GQ Gerasiov <gq@debian.org>
Build-Depends: debhelper (>= 7.0.0), libmysqlclient15-dev, libnetfilter-queue-dev, libpcap0.8-dev, cdbs, po-debconf, libglib2.0-dev
Standards-Version: 3.8.3
Homepage: http://www.netams.com
Vcs-Git: git://git.gq.net.ru/netams.git
Vcs-Browser: http://git.gq.net.ru/?p=netams.git

Package: netams
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, dbconfig-common, lsb-base, dbconfig-common, lsb-base
Recommends: netams-web, apache2|lighttpd|httpd
Suggests: mysql-server|postgresql
Description: network traffic accounting and monitoring daemon
 NeTAMS stands for Network Traffic Accounting and Monitoring Software.
 It supports several mechanisms for traffic statistics gathering
 (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph), database
 storage (Berkeley DB/MySQL/PostgresSQL/Oracle/RADIUS), aggregation,
 visualization, notification, etcetera, and works for networks with
 either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can block
 traffic based on quotas, web authorization, MAC address, or account
 balance (billing); manage bandwidth, or RADIUS services; and create
 flexible accounting and filtering policies.
 .
 This package provides the main daemon for NetAMS.

Package: netams-dbg
Architecture: any
Section: debug
Priority: extra
Depends: netams (= ${binary:Version}), ${misc:Depends}
Description: debug symbols for NeTAMS
 NeTAMS stands for Network Traffic Accounting and Monitoring Software.
 It supports several mechanisms for traffic statistics gathering
 (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph), database
 storage (Berkeley DB/MySQL/PostgresSQL/Oracle/RADIUS), aggregation,
 visualization, notification, etcetera, and works for networks with
 either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can block
 traffic based on quotas, web authorization, MAC address, or account
 balance (billing); manage bandwidth, or RADIUS services; and create
 flexible accounting and filtering policies.
 .
 This package provides NeTAMS debugging symbols.

Package: netams-web
Architecture: all
Depends: ${shlibs:Depends}, ${misc:Depends}, apache2|httpd-cgi, libcrypt-generatepassword-perl, libgd-gd2-perl
Recommends: libdbd-mysql-perl|libdbd-pg-perl
Suggests: netams
Description: web interface for NeTAMS
 NeTAMS stands for Network Traffic Accounting and Monitoring Software.
 It supports several mechanisms for traffic statistics gathering
 (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph), database
 storage (Berkeley DB/MySQL/PostgresSQL/Oracle/RADIUS), aggregation,
 visualization, notification, etcetera, and works for networks with
 either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can block
 traffic based on quotas, web authorization, MAC address, or account
 balance (billing); manage bandwidth, or RADIUS services; and create
 flexible accounting and filtering policies.
 .
 This package provides a web interface for using and administering the
 NetAMS server.
--- ../netams-3.4.3+dfsg1.pristine/debian/netams-web.templates	2009-11-24 11:41:49.000000000 +0000
+++ debian/netams-web.templates	2009-12-31 10:40:01.000000000 +0000
@@ -3,4 +3,4 @@
 Choices: apache2, lighttpd
 _Description: Web server to reconfigure automatically:
  Please choose the web server that should be automatically configured
- to show NeTAMS webinterface.
+ for NeTAMS.
--- ../netams-3.4.3+dfsg1.pristine/debian/netams.templates	2009-11-24 11:41:49.000000000 +0000
+++ debian/netams.templates	2009-12-31 10:40:04.000000000 +0000
@@ -3,23 +3,25 @@
 Choices: apache2, lighttpd
 _Description: Web server to reconfigure automatically:
  Please choose the web server that should be automatically configured
- to show NeTAMS statistics.
+ for NeTAMS statistics.
 
 Template: netams/admin-password
 Type: password
 _Description: NeTAMS administrator password:
- Please enter password for "admin" user in NeTAMS database.
+ Please specify a password for the "admin" user of NeTAMS.
 
 Template: netams/admin-password-again
 Type: password
-_Description: Repeat password for NeTAMS user "admin":
+_Description: NeTAMS administrator password confirmation:
 
 Template: netams/password-mismatch
 Type: error
-_Description: Password input error!
- The two passwords you entered were not the same. Please try again.
+_Description: Password mismatch
+ The two passwords you entered were not the same. Please enter a password
+ again.
 
 Template: netams/password-empty
 Type: error
-_Description: Password input error!
- Please enter non-empty password.
+_Description: Empty password
+ You entered an empty password, which is not allowed. Please choose a non-
+ empty password.
--- ../netams-3.4.3+dfsg1.pristine/debian/control	2009-11-24 11:44:41.000000000 +0000
+++ debian/control	2009-12-31 10:40:17.000000000 +0000
@@ -13,41 +13,52 @@
 Depends: ${shlibs:Depends}, ${misc:Depends}, dbconfig-common, lsb-base, dbconfig-common, lsb-base
 Recommends: netams-web, apache2|lighttpd|httpd
 Suggests: mysql-server|postgresql
-Description: Network Traffic Accounting and Monitoring Software
+Description: network traffic accounting and monitoring daemon
  NeTAMS stands for Network Traffic Accounting and Monitoring Software.
- It is built for UNIX and works for networks with Cisco routers or PC Unix
- routers (Linux/FreeBSD/Solaris). Several methods of traffic gathering are
- supported (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph),
- database storage (BerkleyDB/MySQL/PostgresSQL/Oracle/Radius), aggregation,
- visualization, notification etc. It is possible to block traffic based on
- quotas, web authorization, account balance (billing); manage bandwidth, MAC
- assignmant violations, RADIUS services, create a flexible accounting and
- filtering policies.
+ It supports several mechanisms for traffic statistics gathering
+ (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph), database
+ storage (Berkeley DB/MySQL/PostgresSQL/Oracle/RADIUS), aggregation,
+ visualization, notification, etcetera, and works for networks with
+ either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can block
+ traffic based on quotas, web authorization, MAC address, or account
+ balance (billing); manage bandwidth, or RADIUS services; and create
+ flexible accounting and filtering policies.
  .
- This package contains netams daemon.
+ This package provides the main daemon for NetAMS.
 
 Package: netams-dbg
 Architecture: any
 Section: debug
 Priority: extra
 Depends: netams (= ${binary:Version}), ${misc:Depends}
-Description: Debug symbols for the NeTAMS
- This package includes the debugging symbols for NeTAMS.
+Description: debug symbols for NeTAMS
+ NeTAMS stands for Network Traffic Accounting and Monitoring Software.
+ It supports several mechanisms for traffic statistics gathering
+ (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph), database
+ storage (Berkeley DB/MySQL/PostgresSQL/Oracle/RADIUS), aggregation,
+ visualization, notification, etcetera, and works for networks with
+ either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can block
+ traffic based on quotas, web authorization, MAC address, or account
+ balance (billing); manage bandwidth, or RADIUS services; and create
+ flexible accounting and filtering policies.
+ .
+ This package provides NeTAMS debugging symbols.
 
 Package: netams-web
 Architecture: all
 Depends: ${shlibs:Depends}, ${misc:Depends}, apache2|httpd-cgi, libcrypt-generatepassword-perl, libgd-gd2-perl
 Recommends: libdbd-mysql-perl|libdbd-pg-perl
 Suggests: netams
-Description: NetAMS's web-interface
+Description: web interface for NeTAMS
  NeTAMS stands for Network Traffic Accounting and Monitoring Software.
- It is built for UNIX and works for networks with Cisco routers or PC
- Unix routers (Linux/FreeBSD/Solaris). Several methods of traffic
- gathering are supported (tee/divert/ip_queue/libpcap/ulog/netflow v5
- and v9/netgraph), database storage (BerkleyDB/MySQL/PostgresSQL/
- Oracle/Radius), aggregation, visualization, notification etc. It is
- possible to block traffic based on quotas, web authorization, account
- balance (billing); manage bandwidth, MAC assignmant violations, RADIUS
- services, create a flexible accounting and filtering policies.
+ It supports several mechanisms for traffic statistics gathering
+ (tee/divert/ip_queue/libpcap/ulog/netflow v5 and v9/netgraph), database
+ storage (Berkeley DB/MySQL/PostgresSQL/Oracle/RADIUS), aggregation,
+ visualization, notification, etcetera, and works for networks with
+ either Cisco or Unix-based routers (Linux/FreeBSD/Solaris). It can block
+ traffic based on quotas, web authorization, MAC address, or account
+ balance (billing); manage bandwidth, or RADIUS services; and create
+ flexible accounting and filtering policies.
  .
- This package contain admin and user web-interface for netams server.
+ This package provides a web interface for using and administering the
+ NetAMS server.

Reply to: