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

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





2009/3/7 Christian Perrier <bubulle@debian.org>
Please find, for review, the debconf templates and packages descriptions for the nut source package.

This review will last from Saturday, March 07, 2009 to Tuesday, March 17, 2009.

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:

Please note that I proposed dropping the debconf template that's now useless..:-)

--- nut.old/debian/nut.templates        2009-02-27 07:58:31.115276126 +0100
+++ nut/debian/nut.templates    2009-03-03 22:16:41.300369332 +0100
@@ -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 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.
 .
- 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.


Shorten and simplify all this....Anyway, this is really useless. Don't
waste hours on reviewing this..:-)


--- nut.old/debian/control      2009-02-27 07:58:31.344200481 +0100
+++ nut/debian/control  2009-03-07 14:28:52.790950485 +0100
@@ -17,13 +17,13 @@
 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
+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.

Rewrite the boilerplate:
- capitalize the framework's name
- permits the sharing of-->permits sharing  This is probably easy to
 rewrite this
- no need to quote "server" and "client", imho

disagreed. the package split will evolve and provide in the future the server side (upsd + drivers) and client side (upsmon, upsc, upsrw, upscmd) separatly so that installing a network client doesn't require the full framework. The client / server is really important, and part of the toolkit / framework approach of NUT.
 
 .
- 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.

"the core system of what"?


of NUT, ie the serial / USB drivers, data servers (upsd) and clients.
maybe "provides the core components of NUT..."
 
  Package: nut-cgi
@@ -32,83 +32,80 @@
 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
+Description: network UPS tools - web interface
+ 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.
 .
- 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
+ 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.

This package contains-->this package provides. Standardized wording.

This is "a" web interface. After all, there could be another one..:)

good catch, there is already another one underway. imo, I'll keep both in the end, but still have to do upstream work before having a clear picture.
More cute and shiny:
http://arnaud.quette.free.fr/NUT/nut_charts.png
http://arnaud.quette.free.fr/NUT/nut_stats.png
 
[...]

more feedback in the following mail.

cheers,
Arnaud
--
Linux / Unix Expert R&D - Eaton - http://www.eaton.com/mgeops
Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/
Debian Developer - http://people.debian.org/~aquette/
Free Software Developer - http://arnaud.quette.free.fr/

Reply to: