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

Re: [RFR] templates://nut/{nut.templates}



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

>  Template: nut/major_upstream_changes
> +Type: error
> +_Description: Configuration files changes required
> + Because of numerous changes by upstream authors to nut's behaviour
> + and configuration files handling, it is required to modify the
> + /etc/nut/nut.conf file before nut can be restarted.

   _Description: Configuration changes required
    Because of numerous changes by upstream authors to NUT's behavior and
    configuration file handling, /etc/nut/nut.conf must be modified before
    NUT can be restarted.

>   Please read /usr/share/doc/nut/UPGRADING.gz for the upgrading procedure.

(This is outside d-l-e jurisdiction, but shouldn't it be somewhere
that apt-listchanges will see?)
 
Control file:
> -Description: The core system of the nut - Network UPS Tools
> - nut is a client/server uninterruptible power supply (UPS) monitoring system
> - that permits the sharing of one (or more) UPS between several machines. The
> - 'server' monitors the UPS and notifies the 'clients' when the UPS is on
> +Description: network UPS tools - core system
> 
> Standardize on the most common format for package synopsis with
> repetitive parts.
> 
> + NUT is a client/server uninterruptible power supply (UPS) monitoring system
> + that permits sharing one (or more) UPS between several machines. The
> + server monitors the UPS and notifies its clients when the UPS is on
>   or has a low battery.

There's no good way of pluralising "UPS"; the trick I'd recommend is
to use "hardware" (where the problem is in the other direction):

    NUT is a client/server monitoring system that allows computers to share
    uninterruptible power supply (UPS) hardware. The server monitors the UPS
    and notifies its clients when the UPS is on or has a low battery.
 
>  Package: nut-cgi
>  Recommends: apache | httpd

(Surely httpd-cgi?)

[...]
> + This package provides a web interface for Network UPS Tools. It adds
> + an HTTP interface to the core nut system so that one is able to monitor 
>   the core system with a web browser.

No need to say both "web interface" and "HTTP interface" (and then
explain it) here when the synopsis already has "web interface".

    This package provides an HTTP interface for Network UPS Tools which makes
    it possible to monitor the core NUT system with a web browser.

>  Package: nut-snmp
[...]
> + This package provides snmp-ups, the Meta SNMP UPS Driver, which supports
>   different MIBS (IETF, MGE, APC) for Network UPS Tools. It adds an SNMP 
> + Manager interface to the core system.

What if anything is Meta SNMP?  It's another of those phrases that's all
over Google but only because of these package descriptions.  Rehouse the
jargon ousted from the synopsis instead.

    This package provides snmp-ups, the SNMP multi-MIB driver for UPS, which
    supports various MIBs including IETF, MGE, and APC. It adds an SNMP
    Manager interface to the core NUT system.

The docs say it also supports a couple of other MIBs (not MIBS), so
I've made the list clearly nonexhaustive.

>  Package: nut-hal-drivers
[...]
> + This package provides addons for the hardware abstraction layer (HAL) that
> + allow desktop environments to monitor locally-connected UPS equipments. The
                                                                         X
>   HAL drivers cannot be used at the same time as the normal NUT upsd.

(Equipment's like hardware.)
  
>  Package: nut-xml
[...]
> + This package provides netxml-ups, which support all recent MGE models which
                                                  ^s                      that
>   use a Network Management Card or Proxy (MGE XML/HTTP protocol based). This
> + applies to both MGE Office Protection Systems and to MGE UPS SYSTEMS.
                                                      XX         Systems.

"HTTP protocol" seems redundant, but presumably this is MGE-specific.
  
>  Package: nut-powerman-pdu
[...]
> + This package provides powerman-pdu, which support client communication with the
>   PowerMan daemon to provide Power Distribution Units support.

Uses "support" and "provide" twice each.

    This package provides powerman-pdu, which allows NUT clients to communicate
    with the PowerMan daemon to support Power Distribution Units.

>  Package: libupsclient1
[...]
> +Description: network UPS tools - Client library
                                    c
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- ../nut-2.4.1.pristine/debian/nut-cgi.templates	2009-02-27 10:52:35.000000000 +0000
+++ debian/nut-cgi.templates	2009-02-27 10:59:33.000000000 +0000
@@ -1,13 +1,10 @@
 Template: nut-cgi/major_template_changes
 Type: note
 _Description: Please manually copy the new HTML template
- This is a serious advisory. Please take note.
- .
- There have been significant changes by the upstream author to the
- behaviour of this software. Specifically, the HTML templates in
- /etc/nut are different, due to a naming scheme change.
+ This release of NUT changes the naming scheme used for the HTML
+ templates in /etc/nut.
  .
  If you continue with the installation of this package, upsstats*.cgi
  will not work until you manually copy the new HTML template from
  /usr/share/doc/nut-cgi/examples/. Please read the instructions in
- /usr/share/doc/nut-cgi/README.Debian.
+ /usr/share/doc/nut-cgi/NEWS.Debian.
--- ../nut-2.4.1.pristine/debian/nut.templates	2009-02-27 10:52:35.000000000 +0000
+++ debian/nut.templates	2009-03-07 16:20:45.000000000 +0000
@@ -1,13 +1,8 @@
 Template: nut/major_upstream_changes
-Type: note
-_Description: Please manually modify your configuration files
- This is a serious advisory. Please take note.
+Type: error
+_Description: Configuration changes required
+ Because of numerous changes by upstream authors to NUT's behavior and
+ configuration file handling, /etc/nut/nut.conf must be modified before
+ NUT can be restarted.
  .
- There have been significant changes by the upstream authors to the
- behaviour of this software. Specifically, the configuration files in
- /etc/nut are different, some drivers have been renamed, ...
- .
- If you continue with the installation of this package, NUT will NOT
- restart unless you manually change your configuration files and edit
- /etc/nut/nut.conf.  You have been warned!
  Please read /usr/share/doc/nut/UPGRADING.gz for the upgrading procedure.
--- ../nut-2.4.1.pristine/debian/control	2009-02-27 10:52:35.000000000 +0000
+++ debian/control	2009-03-07 16:25:44.000000000 +0000
@@ -17,13 +17,12 @@
 Provides: ups-monitor, nut-doc, nut-usb
 Conflicts: ups-monitor, nut-doc, nut-hal-drivers, nut-usb (<< 2.1.0-3), nut-dev (<< 2.2.2)
 Replaces: nut-doc
-Description: The core system of the nut - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
+Description: network UPS tools - core system
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
  .
- This package contains the core system, and the serial and USB UPS drivers.
+ This package provides NUT's core system, and the serial and USB UPS drivers.
  In most cases it is sufficient for a basic UPS monitoring system.
 
 Package: nut-cgi
@@ -32,83 +31,73 @@
 Recommends: apache | httpd
 Suggests: nut
 Replaces: nut (<< 1.1.11)
-Description: A web interface sub system for the nut - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
- .
- This package contains the web interface for Network UPS Tools. It adds
- http interface to the core nut system so that one is able to monitor 
- the core system with a web browser.
+Description: network UPS tools - web interface
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
+ .
+ This package provides an HTTP interface for Network UPS Tools which makes
+ it possible to monitor the core NUT system with a web browser.
 
 Package: nut-snmp
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, nut (>= 1.4.1-pre1)
 Conflicts: nut (<= 1.4.0)
-Description: A meta SNMP Driver subsystem for the nut - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
- .
- This package contains snmp-ups, the Meta SNMP UPS Driver, which support
- different MIBS (IETF, MGE, APC) for Network UPS Tools. It adds an SNMP 
- Manager interface to the core system. You probably don't need it if
- you don't understand what this is all about.
+Description: network UPS tools - SNMP sriver
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
+ .
+ This package provides snmp-ups, the SNMP multi-MIB driver for UPS, which
+ supports various MIBs including IETF, MGE, and APC. It adds an SNMP
+ Manager interface to the core NUT system.
 
 Package: nut-hal-drivers
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, ${udev}
 Conflicts: nut
 Provides: hal-ups-support
-Description: HAL interface for NUT - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
+Description: network UPS tools - HAL interface
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
  .
- This package contains addons for the hardware abstraction layer (HAL) that
+ This package provides addons for the hardware abstraction layer (HAL) that
  allow desktop environments to monitor locally-connected UPS equipment. The
  HAL drivers cannot be used at the same time as the normal NUT upsd.
 
 Package: nut-xml
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, nut (>= 2.2.2)
-Description: MGE XML/HTTP Driver subsystem for the nut - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
+Description: network UPS tools - MGE XML/HTTP driver
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
  .
- This package contains netxml-ups, which support all recent MGE models which
+ This package provides netxml-ups, which supports all recent MGE models that
  use a Network Management Card or Proxy (MGE XML/HTTP protocol based). This
- applies to  both  MGE Office Protection Systems and to MGE UPS SYSTEMS.
- You probably don't need it if you don't understand what this is all about.
+ applies to both MGE Office Protection Systems and to MGE UPS Systems.
 
 Package: nut-powerman-pdu
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, nut (>= 2.4.0), powerman (>= 2.3.3)
-Description: PowerMan PDU Driver subsystem for the nut - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
- .
- This package contains powerman-pdu, which support client communication with the
- PowerMan daemon to provide Power Distribution Units support.
- You probably don't need it if you don't understand what this is all about.
+Description: network UPS tools - PowerMan PDU driver
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
+ .
+ This package provides powerman-pdu, which allows NUT clients to communicate
+ with the PowerMan daemon to support Power Distribution Units.
 
 Package: libupsclient1
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: Client library for the nut - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
+Description: network UPS tools - client library
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
  .
- This package contains the shared client library.
+ This package provides the shared client library.
 
 Package: libupsclient1-dev
 Section: libdevel
@@ -116,11 +105,9 @@
 Depends: libupsclient1 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
 Provides: nut-dev
 Conflicts: nut-dev (<< 2.2.2)
-Description: Development files for NUT - Network UPS Tools
- nut is a client/server uninterruptible power supply (UPS) monitoring system
- that permits the sharing of one (or more) UPS between several machines. The
- 'server' monitors the UPS and notifies the 'clients' when the UPS is on
- or has a low battery.
+Description: network UPS tools - development files
+ NUT is a client/server monitoring system that allows computers to share
+ uninterruptible power supply (UPS) hardware. The server monitors the UPS
+ and notifies its clients when the UPS is on or has a low battery.
  .
- This package contains the development files.
-
+ This package provides the development files.
Template: nut/major_upstream_changes
Type: error
_Description: Configuration changes required
 Because of numerous changes by upstream authors to NUT's behavior and
 configuration file handling, /etc/nut/nut.conf must be modified before
 NUT can be restarted.
 .
 Please read /usr/share/doc/nut/UPGRADING.gz for the upgrading procedure.
Source: nut
Section: admin
Priority: optional
Maintainer: Arnaud Quette <aquette@debian.org>
Uploaders: Luca Filipozzi <lfilipoz@debian.org>
Build-Depends: debhelper (>= 6.0.7~), autoconf, automake, libtool, libgd2-xpm-dev | libgd2-noxpm-dev, libsnmp-dev | libsnmp9-dev, libusb-dev (>= 0.1.8), libhal-dev (>= 0.5.8), hal, libdbus-1-dev, libdbus-glib-1-dev, libglib2.0-dev, po-debconf, libneon27-gnutls-dev | libneon26-gnutls-dev | libneon-dev | libneon27-dev | libneon26-dev, libpowerman0-dev (>= 2.3.3), libwrap0-dev (>= 7.6)
Standards-Version: 3.8.0
Homepage: http://www.networkupstools.org
Vcs-Browser: http://svn.debian.org/wsvn/nut
Vcs-Svn: svn://svn.debian.org/nut/trunk

Package: nut
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf (>= 0.5.00), adduser, lsb-base (>= 3.0-6), ${udev}
Recommends: bash-completion
Suggests: nut-cgi, nut-snmp, nut-dev, nut-xml
Provides: ups-monitor, nut-doc, nut-usb
Conflicts: ups-monitor, nut-doc, nut-hal-drivers, nut-usb (<< 2.1.0-3), nut-dev (<< 2.2.2)
Replaces: nut-doc
Description: network UPS tools - core system
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides NUT's core system, and the serial and USB UPS drivers.
 In most cases it is sufficient for a basic UPS monitoring system.

Package: nut-cgi
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf (>= 0.5.00), adduser
Recommends: apache | httpd
Suggests: nut
Replaces: nut (<< 1.1.11)
Description: network UPS tools - web interface
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides an HTTP interface for Network UPS Tools which makes
 it possible to monitor the core NUT system with a web browser.

Package: nut-snmp
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, nut (>= 1.4.1-pre1)
Conflicts: nut (<= 1.4.0)
Description: network UPS tools - SNMP sriver
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides snmp-ups, the SNMP multi-MIB driver for UPS, which
 supports various MIBs including IETF, MGE, and APC. It adds an SNMP
 Manager interface to the core NUT system.

Package: nut-hal-drivers
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, ${udev}
Conflicts: nut
Provides: hal-ups-support
Description: network UPS tools - HAL interface
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides addons for the hardware abstraction layer (HAL) that
 allow desktop environments to monitor locally-connected UPS equipment. The
 HAL drivers cannot be used at the same time as the normal NUT upsd.

Package: nut-xml
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, nut (>= 2.2.2)
Description: network UPS tools - MGE XML/HTTP driver
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides netxml-ups, which supports all recent MGE models that
 use a Network Management Card or Proxy (MGE XML/HTTP protocol based). This
 applies to both MGE Office Protection Systems and to MGE UPS Systems.

Package: nut-powerman-pdu
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, nut (>= 2.4.0), powerman (>= 2.3.3)
Description: network UPS tools - PowerMan PDU driver
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides powerman-pdu, which allows NUT clients to communicate
 with the PowerMan daemon to support Power Distribution Units.

Package: libupsclient1
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: network UPS tools - client library
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides the shared client library.

Package: libupsclient1-dev
Section: libdevel
Architecture: any
Depends: libupsclient1 (= ${binary:Version}), ${shlibs:Depends}, ${misc:Depends}
Provides: nut-dev
Conflicts: nut-dev (<< 2.2.2)
Description: network UPS tools - development files
 NUT is a client/server monitoring system that allows computers to share
 uninterruptible power supply (UPS) hardware. The server monitors the UPS
 and notifies its clients when the UPS is on or has a low battery.
 .
 This package provides the development files.

Reply to: