Please find, for review, the debconf templates and packages descriptions for the mini-buildd source package.
This review will last from Wednesday, March 31, 2010 to Saturday, April 10, 2010.
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:
--- mini-buildd.old/debian/mini-buildd-common.templates 2010-03-24 20:21:32.246651732 +0100
+++ mini-buildd/debian/mini-buildd-common.templates 2010-03-24 20:35:31.045653267 +0100
@@ -1,11 +1,10 @@
Template: mini-buildd-common/purging_repository
Type: note
-_Description: About to purge your repository
+_Description: Repository purge
You have selected to purge mini-buildd on a repository host.
.
- Puging means to remove the mini-buildd user along with all its
- files, including the repository in "/home/mini-buildd/rep".
+ This choice means that the mini-buildd user will be removed along
+ with all files it is owning, including the repository in
+ "/home/mini-buildd/rep".
.
- If you want to keep that data,
- .
- BACK IT UP NOW BEFORE CONTINUING.
+ In order to keep this data, you need to back it up now.
Templates synopsis should avoid being sentences, but are more "titles.
Correct typo (Puging) and make the second paragraph more explicit.
The end of that template must be changed:
- it relies on a specific debconf interface (things are center on a
80x25 terminal when using the curses interface)
- it is shouting
- it splits a sentence over 3 paragraphs.
We always promoted leaving intelligence to the user, so assuming they
will read textx we show carefully enough. Particularly when we take
care to avoid prompting for too many things...:)
--- mini-buildd.old/debian/mini-buildd-bld.templates 2010-03-24 20:21:32.246651732 +0100
+++ mini-buildd/debian/mini-buildd-bld.templates 2010-03-24 20:33:53.197651098 +0100
@@ -1,54 +1,53 @@
Template: mini-buildd-bld/mbd_defer
Type: boolean
Default: false
+#flag:translate!:4
Description: Defer builder configuration?
To configure builder hosts, the repository host must already be
set up and configured (as all the common configuration is
pulled from there by builder hosts).
.
- Defer configuration in case your mini-buildd repository host is
- not yet set up correctly. You must complete your setup by
- running dpkg-reconfigure manually later.
+ You should defer the configuration in case the mini-buildd repository host is
+ not yet set up correctly. The setup may be completed later by running
+ "dpkg-reconfigure mini-buildd".
.
${STATUS}
Turn the last paragraph in non translatable mode. That will prevent
mistakes.
Avoid imperative form (we always avoid it)
The user *must* not complete the setup. After all, (s)he can decide to
leave the package unconfigured..:-)
Template: mini-buildd-bld/mbd_rephttphost
Type: string
-Description: Repository (http) host name:
- Give the full host name of the repository here -- that is the
- machine where mini-buildd-rep is installed. This will be used
- to retrieve the configuration of the mini-buildd network
- automatically via http.
+Description: HTTP repository host name:
+ Please enter the fully qualified host name of the repository to be
+ used, namely the machine where mini-buildd-rep is installed. This
+ will be used to retrieve the configuration of the mini-buildd network
+ automatically via HTTP.
.
- If you need to specify a different port than the default (80),
- use something like "my.host.com:8088".
+ The needed syntax to specify an alternate port number (instead of
+ default 80) is "my.host.example.com:8088".
Capitalize protocol name.
Avoid imperative form.
Use an official example domain.
Template: mini-buildd-bld/mbd_bldhost
Type: select
Choices: ${BLDHOSTS}
-Description: This builder's id:
- This builder's host name; you see the selection from the
- configuration of mini-buildd-rep. If your host is not listed,
+Description: ID for this builder:
+ Please enter the host name for this builder, from hosts listed by
+ mini-buildd-rep. If this host is not listed,
you need to reconfigure mini-buildd-rep.
- .
- Default is the host matching $(hostname -f).
More common wording for synopsis.
Avoid non-verb sentence in long description. Use our commonly used
"Please enter" construction
Avoid "your" host. After all, who says this is my machine? :-)
Template: mini-buildd-bld/mbd_lvm_vg
Type: string
Default: auto
Description: LVM2 volume group to use:
- You need a dedicated lvm volume group where the chroots are
+ You need a dedicated LVM volume group where the chroots are
maintained (via schroot).
.
In that volume group, mini-buildd will automatically maintain
chroots named mbd-BASEDIST-ID-ARCH (ID is the identity you
- configured in mini-buildd-rep). These names should not collide
+ configured in mini-buildd-rep). These names should not collide
with existing logical volumes in that group, else any
- reasonably sized volume group should work. Either
+ reasonably sized volume group should work.
.
- * Set this to "auto": An image file will be used automagically
- in mini-buildd's home, and a lvm volume group named
- "mini-buildd" be build on that via a loop device.
- * Set it to an existing or to-be custom volume group (if your
- create the volume group manually later, you need to
- reconfigure this package).
+ Possible choices are:
+ - auto: an image file will be created in mini-buildd's home,
+ and an LVM volume group named "mini-buildd" will be using it;
+ - existing or custom volume group: if this volume group doesn't
+ exist now, you'll need to reconfigure this package after creating
+ it.
Capitalize "lvm"
Avoid double spaces after full stops
Revamp the enumeration and prefix it.
Avoid "automagically"
--- mini-buildd.old/debian/control 2010-03-24 20:21:32.246651732 +0100
+++ mini-buildd/debian/control 2010-03-25 18:24:40.092980847 +0100
@@ -10,7 +10,7 @@
Package: mini-buildd-common
Architecture: all
Depends: ${misc:Depends}, adduser, bsd-mailx | mailx, apache2-mpm-worker | httpd, openssh-client, gnupg, wget, sbuild (>= 0.57.7)
-Description: Minimal Debian buildd (common)
+Description: minimal Debian build daemon - common files
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
uncapitalize synopsis
Use de facto standard for multiple binary packages source package synopsis
@@ -23,26 +23,25 @@
Architecture: all
Depends: ${misc:Depends}, mini-buildd-common, python, mini-dinstall (>> 0.6.24), cron, procps
Recommends: logrotate, dwww
-Description: Minimal Debian buildd (repository)
+Description: minimal Debian build daemon - repository
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
on clean builds and package checking.
.
- Install this package on the machine that should hold the
- autobuilder network's repository.
+ This package provides the autobuilder network's repository.
Just describe what the package is doing...and avoids imperative form.
Package: mini-buildd-bld
Architecture: all
Depends: ${misc:Depends}, mini-buildd-common, lvm2, debootstrap (>= 1.0.10lenny1), schroot, dput, dpkg-dev, devscripts (>= 2.10.15)
Recommends: logrotate
-Description: Minimal Debian buildd (builder)
+Description: minimal Debian build daemon - builder
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
on clean builds and package checking.
.
- Install this package on any machine that should act as a
+ This package should be installed on any machine that should act as a
builder for a specific architecture. To successfully configure
a builder, the repository host (see package mini-buildd-rep)
must be fully set up first.
Ditto.
--
Template: mini-buildd-common/purging_repository Type: note _Description: Repository purge You have selected to purge mini-buildd on a repository host. . This choice means that the mini-buildd user will be removed along with all files it is owning, including the repository in "/home/mini-buildd/rep". . In order to keep this data, you need to back it up now.
Template: mini-buildd-rep/mbd_id
Type: string
Description: Mini-buildd's identity:
Identity of the mini-buildd network.
.
The identity is used on several places; most importantly, the
distributions created will be called "BASEDIST-ID". For version
strings, it plays the same role as "bpo" as used by
backports.org.
.
Should be a short mnemonic made with letters only.
Template: mini-buildd-rep/mbd_rephost
Type: string
Description: Repository host name:
Give the repository's host name; this is usually just the
hostname you get via "hostname -f". This will be used to create
URLs for HTTP acccess, and for ssh/scp commands.
Template: mini-buildd-rep/mbd_httpport
Type: string
Default: 80
Description: HTTP port to use:
If you use a dedicated HTTP server not using a standard port;
note that the whole network (i.e., build hosts too) must use
that port.
Template: mini-buildd-rep/mbd_sshport
Type: string
Default: 22
Description: SSH port to use:
If you use a dedicated SSH server not using a standard port;
note that the whole network (i.e., build hosts too) must use
that port.
Template: mini-buildd-rep/mbd_mail
Type: string
Description: Mail address (uploads/builds/failures):
All install, failure or log mails go here; usually, it's a good
idea to set up a mailing list for that.
Template: mini-buildd-rep/mbd_extdocurl
Type: string
Description: External documentation URL:
URL to external documentation.
.
This is just for convenience to provide a link to that URL on
the overview page; just leave empty if you don't have any.
Template: mini-buildd-rep/mbd_dists
Type: multiselect
Choices: ${DISTS}
Description: Basis distributions to support:
Space separated list of basis distributions to support.
Template: mini-buildd-rep/mbd_archs
Type: multiselect
Choices: ${ARCHS}
Description: Architectures to support:
Template: mini-buildd-rep/mbd_apt_allow_unauthenticated
Type: boolean
Default: false
Description: Allow unauthenticated apt?
This flag correspondents to the respective apt and sbuild
options.
.
If you set this to false (highly recommended), you will need to
manually add the keys for extra sources you might have
configured (see ~/.mini-buildd/README for further instructions).
.
The standard Debian Keys should be managed fine by the
*-keyring packages (the paranoid may manually check the
fingerprints after initial chroot setups).
.
Set this to true only if you really trust your configured
sources.
Template: mini-buildd-rep/mbd_archall
Type: select
Choices: ${ARCHS}
Description: Arch of builder to build non-arch binary packages:
One builder machine must have the part to compile arch=all
binary packages; just give that architecture here.
Template: mini-buildd-rep/mbd_source
Type: string
Description: "${KIND}" sources for architecture "${ARCH}":
Apt sources for "${DIST}": ${DESC}
.
Notes:
* To specify more than one source, separate via "backslash n".
* With PIN and PRIO you may optionally set an apt-pin; useful
if an extra source is not in "not-automatic" mode.
* Give arch-specific sources only if needed ("any" is
fallback).
.
Syntax : Apt sources line without leading "deb "[;PIN;PRIO]
Example: ${EXAMPLE}
Template: mini-buildd-rep/mbd_bldhost
Type: string
Description: Build host for architecture ${ARCH}:
Build hosts are installations of mini-buildd-bld for a specific
architecture; they manage the chroots and building for that
architecture.
.
Please give a full hostname here.
.
You may safely give a build host to-be here, and set it up later.
Template: mini-buildd-rep/mbd_deb_build_options
Type: string
Description: Debian build options for architecture ${ARCH}:
Build options as defined for DEB_BUILD_OPTIONS environment
variable (see policy, chapter 4.9.1).
.
The only option that is useful here is "parallel=n"; use this
if you have multiple CPUs/Cores at your hand for this archs
build host. You will then have parallel builds (i.e. faster
builds) for packages that support it.
Template: mini-buildd-rep/overview
Type: note
Description: Repository configuration finished
After the package installation is complete, visit the new home
of your build network:
.
${URL}
.
CAVEAT: You need to enable your httpd's "userdir" option manually.
.
Please note:
* On initial installs, or if you configured new build hosts:
*install* package "mini-buildd-bld" on all resp. build hosts.
* On reconfiguration with changes to supported dists or archs:
*reconfigure* package "mini-buildd-bld" on all build hosts.
Template: mini-buildd-bld/mbd_defer
Type: boolean
Default: false
#flag:translate!:4
Description: Defer builder configuration?
To configure builder hosts, the repository host must already be
set up and configured (as all the common configuration is
pulled from there by builder hosts).
.
You should defer the configuration in case the mini-buildd repository host is
not yet set up correctly. The setup may be completed later by running
"dpkg-reconfigure mini-buildd".
.
${STATUS}
Template: mini-buildd-bld/mbd_rephttphost
Type: string
Description: HTTP repository host name:
Please enter the fully qualified host name of the repository to be
used, namely the machine where mini-buildd-rep is installed. This
will be used to retrieve the configuration of the mini-buildd network
automatically via HTTP.
.
The needed syntax to specify an alternate port number (instead of
default 80) is "my.host.example.com:8088".
Template: mini-buildd-bld/mbd_bldhost
Type: select
Choices: ${BLDHOSTS}
Description: ID for this builder:
Please enter the host name for this builder, from hosts listed by
mini-buildd-rep. If this host is not listed,
you need to reconfigure mini-buildd-rep.
Template: mini-buildd-bld/mbd_lvm_vg
Type: string
Default: auto
Description: LVM2 volume group to use:
You need a dedicated LVM volume group where the chroots are
maintained (via schroot).
.
In that volume group, mini-buildd will automatically maintain
chroots named mbd-BASEDIST-ID-ARCH (ID is the identity you
configured in mini-buildd-rep). These names should not collide
with existing logical volumes in that group, else any
reasonably sized volume group should work.
.
Possible choices are:
- auto: an image file will be created in mini-buildd's home,
and an LVM volume group named "mini-buildd" will be using it;
- existing or custom volume group: if this volume group doesn't
exist now, you'll need to reconfigure this package after creating
it.
--- mini-buildd.old/debian/mini-buildd-common.templates 2010-03-24 20:21:32.246651732 +0100
+++ mini-buildd/debian/mini-buildd-common.templates 2010-03-24 20:35:31.045653267 +0100
@@ -1,11 +1,10 @@
Template: mini-buildd-common/purging_repository
Type: note
-_Description: About to purge your repository
+_Description: Repository purge
You have selected to purge mini-buildd on a repository host.
.
- Puging means to remove the mini-buildd user along with all its
- files, including the repository in "/home/mini-buildd/rep".
+ This choice means that the mini-buildd user will be removed along
+ with all files it is owning, including the repository in
+ "/home/mini-buildd/rep".
.
- If you want to keep that data,
- .
- BACK IT UP NOW BEFORE CONTINUING.
+ In order to keep this data, you need to back it up now.
--- mini-buildd.old/debian/mini-buildd-bld.templates 2010-03-24 20:21:32.246651732 +0100
+++ mini-buildd/debian/mini-buildd-bld.templates 2010-03-31 19:12:37.111487919 +0200
@@ -1,54 +1,53 @@
Template: mini-buildd-bld/mbd_defer
Type: boolean
Default: false
+#flag:translate!:4
Description: Defer builder configuration?
To configure builder hosts, the repository host must already be
set up and configured (as all the common configuration is
pulled from there by builder hosts).
.
- Defer configuration in case your mini-buildd repository host is
- not yet set up correctly. You must complete your setup by
- running dpkg-reconfigure manually later.
+ You should defer the configuration in case the mini-buildd repository host is
+ not yet set up correctly. The setup may be completed later by running
+ "dpkg-reconfigure mini-buildd".
.
${STATUS}
Template: mini-buildd-bld/mbd_rephttphost
Type: string
-Description: Repository (http) host name:
- Give the full host name of the repository here -- that is the
- machine where mini-buildd-rep is installed. This will be used
- to retrieve the configuration of the mini-buildd network
- automatically via http.
+Description: HTTP repository host name:
+ Please enter the fully qualified host name of the repository to be
+ used, namely the machine where mini-buildd-rep is installed. This
+ will be used to retrieve the configuration of the mini-buildd network
+ automatically via HTTP.
.
- If you need to specify a different port than the default (80),
- use something like "my.host.com:8088".
+ The needed syntax to specify an alternate port number (instead of
+ default 80) is "my.host.example.com:8088".
Template: mini-buildd-bld/mbd_bldhost
Type: select
Choices: ${BLDHOSTS}
-Description: This builder's id:
- This builder's host name; you see the selection from the
- configuration of mini-buildd-rep. If your host is not listed,
+Description: ID for this builder:
+ Please enter the host name for this builder, from hosts listed by
+ mini-buildd-rep. If this host is not listed,
you need to reconfigure mini-buildd-rep.
- .
- Default is the host matching $(hostname -f).
Template: mini-buildd-bld/mbd_lvm_vg
Type: string
Default: auto
Description: LVM2 volume group to use:
- You need a dedicated lvm volume group where the chroots are
+ You need a dedicated LVM volume group where the chroots are
maintained (via schroot).
.
In that volume group, mini-buildd will automatically maintain
chroots named mbd-BASEDIST-ID-ARCH (ID is the identity you
- configured in mini-buildd-rep). These names should not collide
+ configured in mini-buildd-rep). These names should not collide
with existing logical volumes in that group, else any
- reasonably sized volume group should work. Either
+ reasonably sized volume group should work.
.
- * Set this to "auto": An image file will be used automagically
- in mini-buildd's home, and a lvm volume group named
- "mini-buildd" be build on that via a loop device.
- * Set it to an existing or to-be custom volume group (if your
- create the volume group manually later, you need to
- reconfigure this package).
+ Possible choices are:
+ - auto: an image file will be created in mini-buildd's home,
+ and an LVM volume group named "mini-buildd" will be using it;
+ - existing or custom volume group: if this volume group doesn't
+ exist now, you'll need to reconfigure this package after creating
+ it.
--- mini-buildd.old/debian/control 2010-03-24 20:21:32.246651732 +0100
+++ mini-buildd/debian/control 2010-03-25 18:24:40.092980847 +0100
@@ -10,7 +10,7 @@
Package: mini-buildd-common
Architecture: all
Depends: ${misc:Depends}, adduser, bsd-mailx | mailx, apache2-mpm-worker | httpd, openssh-client, gnupg, wget, sbuild (>= 0.57.7)
-Description: Minimal Debian buildd (common)
+Description: minimal Debian build daemon - common files
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
@@ -23,26 +23,25 @@
Architecture: all
Depends: ${misc:Depends}, mini-buildd-common, python, mini-dinstall (>> 0.6.24), cron, procps
Recommends: logrotate, dwww
-Description: Minimal Debian buildd (repository)
+Description: minimal Debian build daemon - repository
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
on clean builds and package checking.
.
- Install this package on the machine that should hold the
- autobuilder network's repository.
+ This package provides the autobuilder network's repository.
Package: mini-buildd-bld
Architecture: all
Depends: ${misc:Depends}, mini-buildd-common, lvm2, debootstrap (>= 1.0.10lenny1), schroot, dput, dpkg-dev, devscripts (>= 2.10.15)
Recommends: logrotate
-Description: Minimal Debian buildd (builder)
+Description: minimal Debian build daemon - builder
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
on clean builds and package checking.
.
- Install this package on any machine that should act as a
+ This package should be installed on any machine that should act as a
builder for a specific architecture. To successfully configure
a builder, the repository host (see package mini-buildd-rep)
must be fully set up first.
Source: mini-buildd
Section: devel
Priority: extra
Maintainer: Stephan Sürken <absurd@debian.org>
Build-Depends: debhelper (>= 7.0.50~), man-db (>= 2.5.1), po-debconf
Standards-Version: 3.8.4
Vcs-Git: git://git.debian.org/git/collab-maint/mini-buildd.git
Vcs-Browser: http://git.debian.org/?p=collab-maint/mini-buildd.git;a=summary
Package: mini-buildd-common
Architecture: all
Depends: ${misc:Depends}, adduser, bsd-mailx | mailx, apache2-mpm-worker | httpd, openssh-client, gnupg, wget, sbuild (>= 0.57.7)
Description: minimal Debian build daemon - common files
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
on clean builds and package checking.
.
This package includes common parts for both repository and
builder installations.
Package: mini-buildd-rep
Architecture: all
Depends: ${misc:Depends}, mini-buildd-common, python, mini-dinstall (>> 0.6.24), cron, procps
Recommends: logrotate, dwww
Description: minimal Debian build daemon - repository
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
on clean builds and package checking.
.
This package provides the autobuilder network's repository.
Package: mini-buildd-bld
Architecture: all
Depends: ${misc:Depends}, mini-buildd-common, lvm2, debootstrap (>= 1.0.10lenny1), schroot, dput, dpkg-dev, devscripts (>= 2.10.15)
Recommends: logrotate
Description: minimal Debian build daemon - builder
Mini-buildd is an easy-to-setup Debian autobuilder and
repository. Its general notion is that of addons for a Debian
base distribution (like etch, lenny, or sid) with an emphasis
on clean builds and package checking.
.
This package should be installed on any machine that should act as a
builder for a specific architecture. To successfully configure
a builder, the repository host (see package mini-buildd-rep)
must be fully set up first.
Attachment:
signature.asc
Description: Digital signature