[DRE-maint] Bug#685578: [RFR] templates://chef-solr/{chef-solr.templates}

[Christian PERRIER]

Please find, for review, the debconf templates and packages descriptions for the chef-solr source package.

This review will last from Saturday, August 25, 2012 to Tuesday, September 04, 2012.

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, a summary will be sent to the review bug report,
and a mail will be sent to this list with "[BTS]" as a subject tag.

Rationale:
--- chef-solr.old/debian/chef-solr.templates	2012-08-22 06:49:46.948799865 +0200
+++ chef-solr/debian/chef-solr.templates	2012-08-25 19:03:37.393593077 +0200
@@ -1,12 +1,13 @@
 Template: chef-solr/amqp_password
 Type: password
-Description: New password for the 'chef' AMQP user in the RabbitMQ vhost "/chef":
-  Set the password for the chef user in the AMQP server queue. Use
-  RabbitMQ's rabbitmqctl program to set this password. The default user
-  and vhost are assumed (chef and /chef, respectively).
-  .
-  RabbitMQ does not have the capability to read the password from a file, and
-  this will be passed via "" on the command-line. As such, do not use shell
-  meta-characters that could cause errors such as !.
-  .
-  This will be used in /etc/chef/solr.rb and /etc/chef/server.rb as 'amqp_pass'.
+_Description: AMQP user password:
+ Please choose the password for the "chef" AMQP user in the RabbitMQ
+ vhost "/chef".
+ .
+ As the rabbitmqctl utility does not have the capability to read the
+ password from a file, it this will be passed to it as a quoted string.
+ As a consequence, shell meta-characters, such as the exclamation mark
+ character cause errors.
+ .
+ The password will be stored in /etc/chef/solr.rb and /etc/chef/server.rb
+ as "amqp_pass".

First.....make the template translatable.

Then: avoid having it hardcoded because there are double leading
spaces.

Then: rewrite the synopsis to avoid a completely quasi-cryptographic
sentence..:-)

Then: give the most important information to users as first paragraph.

Then: rewrite the second paragraph to what I think is better
style..:-)

Here or there: standardize on double quotes.


Note: I had no courage to review the package description which is a
nice piece of jargon..:)

-- 


-------------- next part --------------
Template: chef-solr/amqp_password
Type: password
_Description: AMQP user password:
 Please choose the password for the "chef" AMQP user in the RabbitMQ
 vhost "/chef".
 .
 As the rabbitmqctl utility does not have the capability to read the
 password from a file, it this will be passed to it as a quoted string.
 As a consequence, shell meta-characters, such as the exclamation mark
 character cause errors.
 .
 The password will be stored in /etc/chef/solr.rb and /etc/chef/server.rb
 as "amqp_pass".
-------------- next part --------------
--- chef-solr.old/debian/chef-solr.templates	2012-08-22 06:49:46.948799865 +0200
+++ chef-solr/debian/chef-solr.templates	2012-08-25 19:03:37.393593077 +0200
@@ -1,12 +1,13 @@
 Template: chef-solr/amqp_password
 Type: password
-Description: New password for the 'chef' AMQP user in the RabbitMQ vhost "/chef":
-  Set the password for the chef user in the AMQP server queue. Use
-  RabbitMQ's rabbitmqctl program to set this password. The default user
-  and vhost are assumed (chef and /chef, respectively).
-  .
-  RabbitMQ does not have the capability to read the password from a file, and
-  this will be passed via "" on the command-line. As such, do not use shell
-  meta-characters that could cause errors such as !.
-  .
-  This will be used in /etc/chef/solr.rb and /etc/chef/server.rb as 'amqp_pass'.
+_Description: AMQP user password:
+ Please choose the password for the "chef" AMQP user in the RabbitMQ
+ vhost "/chef".
+ .
+ As the rabbitmqctl utility does not have the capability to read the
+ password from a file, it this will be passed to it as a quoted string.
+ As a consequence, shell meta-characters, such as the exclamation mark
+ character cause errors.
+ .
+ The password will be stored in /etc/chef/solr.rb and /etc/chef/server.rb
+ as "amqp_pass".
-------------- next part --------------
Source: chef-solr
Section: ruby
Priority: optional
Maintainer: Debian Ruby Extras Maintainers <pkg-ruby-extras-maintainers at lists.alioth.debian.org>
Uploaders: Bryan McLellan <btm at loftninjas.org>
DM-Upload-Allowed: yes
Build-Depends: debhelper (>= 7.0.50~), gem2deb (>= 0.3.0~)
Standards-Version: 3.9.2
#Vcs-Git: git://git.debian.org/pkg-ruby-extras/chef-solr.git
#Vcs-Browser: http://git.debian.org/?p=pkg-ruby-extras/chef-solr.git;a=summary
Homepage: http://wiki.opscode.com/display/chef
XS-Ruby-Versions: all

Package: chef-solr
Architecture: all
XB-Ruby-Versions: ${ruby:Versions}
Depends: ${shlibs:Depends}, ${misc:Depends}, ruby-interpreter, rabbitmq-server (>= 1.6), default-jre-headless | java6-runtime-headless, ruby-json (>= 1.4.6), chef (>= 0.10.10), solr-jetty (>= 1.4.0), ruby-libxml, adduser, ucf
Replaces: chef-indexer
Conflicts: chef-indexer
Description: Manages search indexes of Chef node attributes using Solr
 The chef indexer listens to a message queue via AMQP for changes to search
 indexes. It then either creates or deletes entries in the index according
 to the information it is passed.
 .
 This package provides the chef-solr search engine which runs as a solr-jetty
 server, and chef-solr-indexer that talks to the AMQP message queue, by
 default rabbitmq-server.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/pkg-ruby-extras-maintainers/attachments/20120825/147b2194/attachment.pgp>