[Pkg-puppet-devel] [RFR] templates://mcollective/{mcollective-common.templates, mcollective.templates}

Christian PERRIER bubulle at debian.org
Thu Sep 22 06:46:38 UTC 2011 

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

This review will last from Thursday, September 22, 2011 to Sunday, October 02, 2011.

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:
--- mcollective.old/debian/mcollective-common.templates	2011-09-17 08:42:29.783109275 +0200
+++ mcollective/debian/mcollective-common.templates	2011-09-22 08:40:41.684021730 +0200
@@ -1,31 +1,31 @@
 Template: mcollective/security_psk
 Type: string
 Default: unset
-_Description: Security PSK key for all MCollective instances:
- Please specify the psk for security within your MCollective
- instances
+_Description: Pre-shared key for all MCollective instances:
+ Please specify the pre-shared key that should be used between
+ MCollective instances.

PSK is too jargonic, so let's expand. With my changes, the concept of
"security" disappeared. Not sure if it is worth keeping.

Maybe "should be used forcommunication between MCollective instances"?
 
 Template: mcollective/stomp_host
 Type: string
 Default: localhost
-_Description: Hostname of your ActiveMQ host:
- Please specify the hostname/ip address of your Message Queue
+_Description: Hostname of the ActiveMQ host:
+ Please specify the hostname or IP address of the Message Queue
  server (Apache ActiceMQ).

Unpersonnalize (not necessarily "my" host). "IP" should be capitalized.
 
 Template: mcollective/stomp_port
 Type: string
 Default: 6163
-_Description: Port of your ActiveMQ instance:
- Please specify the port of your Message Queue server (Apache ActiveMQ).
+_Description: Port of the ActiveMQ instance:
+ Please specify the listening port of the Message Queue server (Apache ActiveMQ).

Same changes.
 
 Template: mcollective/stomp_user
 Type: string
 Default: mcollective
-_Description: STOMP user from your ActiveMQ instance:
- Please specify the username of your Message Queue server (Apache ActiveMQ).
+_Description: STOMP user name:
+ Please specify the username that should be used with the Message Queue server (Apache ActiveMQ).

I don't really know what "STOMP" stands for. Either this is something
completely obvious to MCollective users....or this should be explained
in the long description.

 
 Template: mcollective/stomp_password
 Type: password
 Default: marionette
-_Description: STOMP password from your ActiveMQ instance:
- Please specify the password of your Message Queue server (Apache ActiveMQ).
+_Description: STOMP user password:
+ Please specify the password of the STOMP user on the Message Queue server (Apache ActiveMQ).

Similar changes.


--- mcollective.old/debian/mcollective.templates	2011-09-17 08:42:29.783109275 +0200
+++ mcollective/debian/mcollective.templates	2011-09-21 07:12:47.534282968 +0200
@@ -1,5 +1,6 @@
 Template: mcollective/start_on_boot
 Type: boolean
 Default: false
-_Description: Should MCollective started onboot?
- Start MCollective daemon onboot.
+_Description: Should MCollective be started at boot?
+ Please choose whether the MCollective daemon should be started when
+ booting this machine.

Grammatical correction (hopefully correct, Justin?)

More verbosity in the long description.


--- mcollective.old/debian/control	2011-09-17 08:42:29.783109275 +0200
+++ mcollective/debian/control	2011-09-21 07:20:54.942124143 +0200
@@ -14,8 +14,8 @@
 Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
 Suggests: activemq
 Recommends: mcollective-client
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+Description: build server/parallel job execution systems - daemon

It's not really a good idea to have all binary packages sharing the
same description. Use our usual trick in such case.


+ The Marionette Collective, also known as "mcollective", is a framework
  to build server orchestration or parallel job execution systems.
  .
  This package contains the MCollective daemon.

Expand jargonic "aka"


@@ -24,11 +24,11 @@
 Architecture: all
 Suggests: mcollective
 Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
- to build server orchestration or parallel job execution system
+Description: build server/parallel job execution systems - client software
+ The Marionette Collective, also known as "mcollective", is a framework
+ to build server orchestration or parallel job execution systems.
  .
- This package contains the MCollective client stuff:
+ This package provides the MCollective client utilities:

Let's use less trivial language..:-)

   - mco
   - mc-rpc
   - mc-facts
@@ -42,18 +42,18 @@
 Architecture: all
 Suggests: mcollective-doc
 Depends: ${misc:Depends}, ruby | ruby-interpreter, rubygems, libstomp-ruby, libsystemu-ruby, ruby-json
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+Description: build server/parallel job execution systems - common files
+ The Marionette Collective, also known as "mcollective", is a framework
  to build server orchestration or parallel job execution systems.
  .
- Common files for mcollective packages.
+ The package provides the common files for mcollective packages.


Let's make sentences..:-)
 
 Package: mcollective-doc
 Architecture: all
 Section: doc
 Depends: ${misc:Depends}
-Description: Documentation for mcollective
+Description: build server/parallel job execution systems - documentation
  The Marionette Collective aka. mcollective is a framework
  to build server orchestration or parallel job execution systems.
  .
- Documentation package.
+ The package provides the documentation for Marionette Collective.


Ditto.



-- 


-------------- next part --------------
Template: mcollective/security_psk
Type: string
Default: unset
_Description: Pre-shared key for all MCollective instances:
 Please specify the pre-shared key that should be used between
 MCollective instances.

Template: mcollective/stomp_host
Type: string
Default: localhost
_Description: Hostname of the ActiveMQ host:
 Please specify the hostname or IP address of the Message Queue
 server (Apache ActiceMQ).

Template: mcollective/stomp_port
Type: string
Default: 6163
_Description: Port of the ActiveMQ instance:
 Please specify the listening port of the Message Queue server (Apache ActiveMQ).

Template: mcollective/stomp_user
Type: string
Default: mcollective
_Description: STOMP user name:
 Please specify the username that should be used with the Message Queue server (Apache ActiveMQ).

Template: mcollective/stomp_password
Type: password
Default: marionette
_Description: STOMP user password:
 Please specify the password of the STOMP user on the Message Queue server (Apache ActiveMQ).
-------------- next part --------------
Template: mcollective/start_on_boot
Type: boolean
Default: false
_Description: Should MCollective be started at boot?
 Please choose whether the MCollective daemon should be started when
 booting this machine.
-------------- next part --------------
--- mcollective.old/debian/mcollective-common.templates	2011-09-17 08:42:29.783109275 +0200
+++ mcollective/debian/mcollective-common.templates	2011-09-22 08:40:41.684021730 +0200
@@ -1,31 +1,31 @@
 Template: mcollective/security_psk
 Type: string
 Default: unset
-_Description: Security PSK key for all MCollective instances:
- Please specify the psk for security within your MCollective
- instances
+_Description: Pre-shared key for all MCollective instances:
+ Please specify the pre-shared key that should be used between
+ MCollective instances.
 
 Template: mcollective/stomp_host
 Type: string
 Default: localhost
-_Description: Hostname of your ActiveMQ host:
- Please specify the hostname/ip address of your Message Queue
+_Description: Hostname of the ActiveMQ host:
+ Please specify the hostname or IP address of the Message Queue
  server (Apache ActiceMQ).
 
 Template: mcollective/stomp_port
 Type: string
 Default: 6163
-_Description: Port of your ActiveMQ instance:
- Please specify the port of your Message Queue server (Apache ActiveMQ).
+_Description: Port of the ActiveMQ instance:
+ Please specify the listening port of the Message Queue server (Apache ActiveMQ).
 
 Template: mcollective/stomp_user
 Type: string
 Default: mcollective
-_Description: STOMP user from your ActiveMQ instance:
- Please specify the username of your Message Queue server (Apache ActiveMQ).
+_Description: STOMP user name:
+ Please specify the username that should be used with the Message Queue server (Apache ActiveMQ).
 
 Template: mcollective/stomp_password
 Type: password
 Default: marionette
-_Description: STOMP password from your ActiveMQ instance:
- Please specify the password of your Message Queue server (Apache ActiveMQ).
+_Description: STOMP user password:
+ Please specify the password of the STOMP user on the Message Queue server (Apache ActiveMQ).
--- mcollective.old/debian/mcollective.templates	2011-09-17 08:42:29.783109275 +0200
+++ mcollective/debian/mcollective.templates	2011-09-21 07:12:47.534282968 +0200
@@ -1,5 +1,6 @@
 Template: mcollective/start_on_boot
 Type: boolean
 Default: false
-_Description: Should MCollective started onboot?
- Start MCollective daemon onboot.
+_Description: Should MCollective be started at boot?
+ Please choose whether the MCollective daemon should be started when
+ booting this machine.
--- mcollective.old/debian/control	2011-09-17 08:42:29.783109275 +0200
+++ mcollective/debian/control	2011-09-21 07:20:54.942124143 +0200
@@ -14,8 +14,8 @@
 Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
 Suggests: activemq
 Recommends: mcollective-client
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+Description: build server/parallel job execution systems - daemon
+ The Marionette Collective, also known as "mcollective", is a framework
  to build server orchestration or parallel job execution systems.
  .
  This package contains the MCollective daemon.
@@ -24,11 +24,11 @@
 Architecture: all
 Suggests: mcollective
 Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
- to build server orchestration or parallel job execution system
+Description: build server/parallel job execution systems - client software
+ The Marionette Collective, also known as "mcollective", is a framework
+ to build server orchestration or parallel job execution systems.
  .
- This package contains the MCollective client stuff:
+ This package provides the MCollective client utilities:
   - mco
   - mc-rpc
   - mc-facts
@@ -42,18 +42,18 @@
 Architecture: all
 Suggests: mcollective-doc
 Depends: ${misc:Depends}, ruby | ruby-interpreter, rubygems, libstomp-ruby, libsystemu-ruby, ruby-json
-Description: build server orchestration or parallel job execution systems
- The Marionette Collective aka. mcollective is a framework
+Description: build server/parallel job execution systems - common files
+ The Marionette Collective, also known as "mcollective", is a framework
  to build server orchestration or parallel job execution systems.
  .
- Common files for mcollective packages.
+ The package provides the common files for mcollective packages.
 
 Package: mcollective-doc
 Architecture: all
 Section: doc
 Depends: ${misc:Depends}
-Description: Documentation for mcollective
+Description: build server/parallel job execution systems - documentation
  The Marionette Collective aka. mcollective is a framework
  to build server orchestration or parallel job execution systems.
  .
- Documentation package.
+ The package provides the documentation for Marionette Collective.
-------------- next part --------------
Source: mcollective
Section: utils
Priority: optional
Maintainer: Puppet Package Maintainers <pkg-puppet-devel at lists.alioth.debian.org>
Uploaders: Jonas Genannt <jonas.genannt at capi2name.de>, Micah Anderson <micah at debian.org>
Build-Depends: debhelper (>= 8)
Standards-Version: 3.9.2
Homepage: http://projects.puppetlabs.com/projects/mcollective
Vcs-Git: git://git.debian.org/git/pkg-puppet/mcollective.git
Vcs-Browser: http://git.debian.org/?p=pkg-puppet/mcollective.git

Package: mcollective
Architecture: all
Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
Suggests: activemq
Recommends: mcollective-client
Description: build server/parallel job execution systems - daemon
 The Marionette Collective, also known as "mcollective", is a framework
 to build server orchestration or parallel job execution systems.
 .
 This package contains the MCollective daemon.

Package: mcollective-client
Architecture: all
Suggests: mcollective
Depends: ${misc:Depends}, ruby | ruby-interpreter, mcollective-common (>= ${source:Version})
Description: build server/parallel job execution systems - client software
 The Marionette Collective, also known as "mcollective", is a framework
 to build server orchestration or parallel job execution systems.
 .
 This package provides the MCollective client utilities:
  - mco
  - mc-rpc
  - mc-facts
  - mc-find-hosts
  - mc-ping
  - mc-call-agent
  - mc-controller
  - mc-inventory

Package: mcollective-common
Architecture: all
Suggests: mcollective-doc
Depends: ${misc:Depends}, ruby | ruby-interpreter, rubygems, libstomp-ruby, libsystemu-ruby, ruby-json
Description: build server/parallel job execution systems - common files
 The Marionette Collective, also known as "mcollective", is a framework
 to build server orchestration or parallel job execution systems.
 .
 The package provides the common files for mcollective packages.

Package: mcollective-doc
Architecture: all
Section: doc
Depends: ${misc:Depends}
Description: build server/parallel job execution systems - documentation
 The Marionette Collective aka. mcollective is a framework
 to build server orchestration or parallel job execution systems.
 .
 The package provides the documentation for Marionette Collective.
-------------- 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-puppet-devel/attachments/20110922/99771486/attachment.pgp>

More information about the Pkg-puppet-devel mailing list