Re: pybit 0.4.0-1: template review
Justin B Rye wrote:
> Oh, and just before I hit send the templates arrive...
So here's my patch, mostly as promised.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru old/pybit-client.templates new/pybit-client.templates
--- old/pybit-client.templates 2012-12-15 20:16:54.614723911 +0000
+++ new/pybit-client.templates 2012-12-15 20:30:33.758723944 +0000
@@ -1,58 +1,57 @@
Template: pybit-client/clientid
Type: string
-_Description: Specify pybit client id string:
- Each client needs to have a unique string to identify itself within
- the job list and queues.
+_Description: PyBit client-ID string:
+ Please specify a unique string that can be used to identify this client
+ within the job list and queues.
Template: pybit-client/lvmsnapshot
Type: boolean
Default: false
-_Description: Use lvm snapshots on this client?
- If your sbuild configuration uses lvm-snapshots, pybit-client can
- ensure that your snapshot apt cache data remains updated whilst
- keeping the snapshot clean.
+_Description: Use LVM snapshots on this client?
+ If the sbuild configuration uses LVM snapshots, pybit-client can ensure
+ that your snapshot APT cache data is kept up-to-date whilst keeping the
+ snapshot clean.
Template: pybit-client/buildroot
Type: string
Default: /home/buildd/pybit
-_Description: Specify the buildd location:
- Please enter a writeable directory where the version control handler
+_Description: Buildd location:
+ Please specify a writeable directory where the version control handler
and the upload task can write files.
.
- If this is empty, the default /home/buildd/pybit will be used.
+ If this is left blank, the default /home/buildd/pybit will be used.
Template: pybit-client/rabbitmqhost
Type: string
-_Description: Specify the host machine running RabbitMQ:
- Each buildd client needs to communicate with a single server running
- rabbitMQ from which it receives the details of the jobs which the
- client needs to attempt to build.
+_Description: Host machine running RabbitMQ:
+ Please specify the server running RabbitMQ that this buildd client will
+ communicate with, receiving details of the jobs it needs to attempt to
+ build.
Template: pybit-client/dputdest
Type: string
-_Description: Specify the dput destination for packages to be uploaded:
- Each client has a dput config for a specific upload machine, specify
- that config name here.
+_Description: Destination for dput package uploads:
+ Please specify the machine that this client will use as upload host.
+ This destination will be stored in its dput configuration.
.
This entry must not be empty.
Template: pybit-client/missingid
Type: note
-_Description: Client id string cannot be empty!
- Any client with an empty clientid (or a clientid which matches an
- existing clientid) will fail to start.
+_Description: Client-ID string cannot be empty!
+ This client will fail to start until it receives a unique client-ID.
Template: pybit-client/missinghost
Type: note
-_Description: RabbitMQ host is empty!
- Any client with a missing rabbitmq host will not receive any
- messages from the queue and will not build any packages.
+_Description: Missing RabbitMQ hostname!
+ This client will not receive any messages from the queue and will
+ not build any packages until a RabbitMQ host is specified.
.
Please edit /etc/pybit/client/client.conf after configuration.
Template: pybit-client/defaultdput
Type: note
-_Description: dput destination cannot be empty!
+_Description: Missing dput destination!
pybit-client is not intended to upload to unspecified dput
destinations like ftp-master.debian.org and does not currently
support GnuPG signed uploads.
diff -ru old/pybit-web.templates new/pybit-web.templates
--- old/pybit-web.templates 2012-12-15 20:16:55.654724110 +0000
+++ new/pybit-web.templates 2012-12-15 20:39:19.326723740 +0000
@@ -1,35 +1,37 @@
Template: pybit-web/rabbitmqhost
Type: string
-_Description: Specify the host machine running RabbitMQ:
- The web frontend and the pybit controller need to communicate with a
- single server running rabbitMQ to which it sends the details of the
+_Description: Host machine running RabbitMQ:
+ Please specify the server running RabbitMQ with which the web front-end
+ and the pyBit controller need to communicate, sending the details of the
jobs to be built.
Template: pybit-web/hostname
Type: string
Default: localhost
-_Description: Specify the fully qualified hostname for the web frontend:
- The pybit controller and the web frontend run on the same machine.
+_Description: Fully qualified hostname for the web front-end:
+ Please specify the host running the web front-end (which will also be
+ running the pyBit controller).
.
- You may choose to use a named apache virtual host or accept the default
- if all your pybit clients also run on this one machine.
+ You may choose to use a named Apache virtual host or accept the default
+ if all the pyBit clients also run on this one machine.
.
- The hostname is passed down to the build clients to allow clients to
- post failure messages back to the controller.
+ The hostname is passed down to the build clients to allow them to post
+ failure messages back to the controller.
Template: pybit-web/port
Type: string
Default: 8080
-_Description: Specify the port on which the web frontend should be available:
- For a localhost installation, it is probably easiest to use 8080.
+_Description: Port for web front-end:
+ Please specify the port that the web front-end should be available on.
+ If it is serving localhost, it is probably easiest to use port 8080.
.
- If the web frontend is running on a dedicated host or an apache
+ If the web front-end is running on a dedicated host or an Apache
virtual host, it may be preferable to use port 80.
Template: pybit-web/missinghost
Type: note
-_Description: RabbitMQ host is empty!
- If the controller has a missing rabbitmq host, none of the build clients
- will receive any messages on the queue and will not build any packages.
+_Description: Missing RabbitMQ hostname!
+ If no RabbitMQ host is specified for the pyBit controller, the build
+ clients will not receive any messages on the queue or build any packages.
.
Please edit /etc/pybit/web/web.conf after configuration.
Template: pybit-client/clientid
Type: string
_Description: PyBit client-ID string:
Please specify a unique string that can be used to identify this client
within the job list and queues.
Template: pybit-client/lvmsnapshot
Type: boolean
Default: false
_Description: Use LVM snapshots on this client?
If the sbuild configuration uses LVM snapshots, pybit-client can ensure
that your snapshot APT cache data is kept up-to-date whilst keeping the
snapshot clean.
Template: pybit-client/buildroot
Type: string
Default: /home/buildd/pybit
_Description: Buildd location:
Please specify a writeable directory where the version control handler
and the upload task can write files.
.
If this is left blank, the default /home/buildd/pybit will be used.
Template: pybit-client/rabbitmqhost
Type: string
_Description: Host machine running RabbitMQ:
Please specify the server running RabbitMQ that this buildd client will
communicate with, receiving details of the jobs it needs to attempt to
build.
Template: pybit-client/dputdest
Type: string
_Description: Destination for dput package uploads:
Please specify the machine that this client will use as upload host.
This destination will be stored in its dput configuration.
.
This entry must not be empty.
Template: pybit-client/missingid
Type: note
_Description: Client-ID string cannot be empty!
This client will fail to start until it receives a unique client-ID.
Template: pybit-client/missinghost
Type: note
_Description: Missing RabbitMQ hostname!
This client will not receive any messages from the queue and will
not build any packages until a RabbitMQ host is specified.
.
Please edit /etc/pybit/client/client.conf after configuration.
Template: pybit-client/defaultdput
Type: note
_Description: Missing dput destination!
pybit-client is not intended to upload to unspecified dput
destinations like ftp-master.debian.org and does not currently
support GnuPG signed uploads.
Template: pybit-web/rabbitmqhost
Type: string
_Description: Host machine running RabbitMQ:
Please specify the server running RabbitMQ with which the web front-end
and the pyBit controller need to communicate, sending the details of the
jobs to be built.
Template: pybit-web/hostname
Type: string
Default: localhost
_Description: Fully qualified hostname for the web front-end:
Please specify the host running the web front-end (which will also be
running the pyBit controller).
.
You may choose to use a named Apache virtual host or accept the default
if all the pyBit clients also run on this one machine.
.
The hostname is passed down to the build clients to allow them to post
failure messages back to the controller.
Template: pybit-web/port
Type: string
Default: 8080
_Description: Port for web front-end:
Please specify the port that the web front-end should be available on.
If it is serving localhost, it is probably easiest to use port 8080.
.
If the web front-end is running on a dedicated host or an Apache
virtual host, it may be preferable to use port 80.
Template: pybit-web/missinghost
Type: note
_Description: Missing RabbitMQ hostname!
If no RabbitMQ host is specified for the pyBit controller, the build
clients will not receive any messages on the queue or build any packages.
.
Please edit /etc/pybit/web/web.conf after configuration.
Reply to: