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

Re: [RFR] templates://mini-buildd/{mini-buildd.templates}



Christian PERRIER wrote:
>  Template: mini-buildd/home
>  Type: string
>  Default: /var/lib/mini-buildd
>  _Description: Home path:
> + Please choose the directory where mini-buildd data will be stored.
> + The directory will also be the home directory for the mini-buildd user.
> + .
> + It should have enough space for all
>   repositories and/or builders data you plan to use.

Is that "any/all repository data and any/all builder data", or what?
Probably clearer as:

    It should have enough space for all the builders and repositories
    you plan to use.
  
>  Template: mini-buildd/admin_password
>  Type: password
> +_Description: Administrator password for mini-buildd:
> + Please choose the password for the administrative user of
> + mini-buildd. This password will be used, for the admin" user
> + in mini-buildd's web interface.

A minor <,> surplus and <"> shortage (thanks, victory).

[...]
>  Template: mini-buildd/options
>  Type: string
>  Default: --verbose
>  _Description: Extra options:
> + Please add any mini-buildd command line option you would like to use
> + (see the output of "mini-buildd --help" for a full set of available
> + options).

Perhaps a case for "(s)", but probably just using plural "any
mini-buildd command line options" is more idiomatic.

> + .
> + The only really recommended option, here, is to
> + increase/decrease the log level via "-v, --verbose" or "-q,
> + --quiet", respectively.

At least the "respectively" works here.  I'd still prefer to avoid it,
though:

    Please add any mini-buildd command line options you would like to use
    ("mini-buildd --help" gives a list of available options).
    .
    The only options really recommended for use here are "-v"/"--verbose"
    to increase the log level or "-q"/"--quiet" to decrease it.

>  Template: mini-buildd/note
>  Type: note
>  _Description: Package configuration complete

Does it mean

   _Description: Configuration of mini-buildd complete

...?  If so, why does this need a debconf note?

>   After the package installation is complete, visit the new home
> + of the local mini-build instance. Unless you changed the
> + defaults, this should be reachable via http://localhost:8066.

When it says "after the package installation", does it mean the
installation of this package it just declared completely installed and
configured?  Or is it talking about something the buildd does?
Assuming the former, it boils down to:

    Unless you changed the defaults, you should now be able to visit the
    new home of the local mini-buildd instance at http://localhost:8066.

And I'd find this message pretty annoying if I had to install
mini-buildd on multiple machines...

In the control file:
> +Description: minimal build daemon - python library and user tool

s/python/Python/

> + Mini-buildd is an easy to configure autobuilder and
> + repository for deb packages.

When "easy to X" is being used as if it was a one-word adjective
before the noun it's entitled to hyphens.

I have to admit I always find "deb package" vaguely annoying, but it
seems to be the best solution.  (And we do need to be clear, when
there are also Python packages about.)

>   .
> + More specifically, this package includes the user space control tool and the
>   'mini_buildd' python package.

Users read "user space" as "stored under ~/" (I saw another real-life
example of this happening just a couple of weeks ago); if we want to
make it clear it's not in kernelspace, we need to write it as one
word.  But how likely is it that anybody would expect a "control tool"
for a buildd to run in kernelspace?  Just say:

    This package includes the control utility "mini-buildd-tool" along
    with the "mini_buildd" Python package.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
diff -ru mini-buildd-1.0.0~gamma.1.pristine/debian/control mini-buildd-1.0.0~gamma.1/debian/control
--- mini-buildd-1.0.0~gamma.1.pristine/debian/control	2013-09-11 16:26:24.000000000 +0100
+++ mini-buildd-1.0.0~gamma.1/debian/control	2013-10-22 14:02:12.189279155 +0100
@@ -35,12 +35,12 @@
          python-argcomplete (>= 0.5.4),
          python-keyring (>= 1.6),
          python-debian (>= 0.1.18~)
-Description: Minimal Debian build daemon: python library and user tool
- mini-buildd is an easy-to-configure Debian autobuilder and
- repository.
+Description: minimal build daemon - python library and user tool
+ Mini-buildd is an easy-to-configure autobuilder and
+ repository for deb packages.
  .
- This package includes the user space control tool and the
- 'mini_buildd' python package.
+ This package includes the control utility "mini-buildd-tool" along
+ with the "mini_buildd" Python package.
 
 Package: mini-buildd
 Architecture: all
@@ -72,14 +72,16 @@
         mini-buildd-bld (<< 1.0.0~)
 Replaces: mini-buildd-rep,
           mini-buildd-bld
-Description: Minimal Debian build daemon
- mini-buildd is an easy-to-configure Debian autobuilder and
- repository.
+Description: minimal build daemon - daemon
+ Mini-buildd is an easy-to-configure autobuilder and
+ repository for deb packages.
+ .
+ This package provides the main daemon.
 
 Package: mini-buildd-common
 Architecture: all
 Depends: ${misc:Depends}
-Description: minimal Debian build daemon - 08x upgrade dummy package
+Description: minimal build daemon - 08x upgrade dummy package
  This is a dummy package assuring mini-buildd-common is
  upgraded (as a possible purge of the 0.8.x package
  would badly break mini-buildd 1.0).
diff -ru mini-buildd-1.0.0~gamma.1.pristine/debian/mini-buildd.templates mini-buildd-1.0.0~gamma.1/debian/mini-buildd.templates
--- mini-buildd-1.0.0~gamma.1.pristine/debian/mini-buildd.templates	2013-08-09 16:08:20.000000000 +0100
+++ mini-buildd-1.0.0~gamma.1/debian/mini-buildd.templates	2013-10-22 14:06:27.437846463 +0100
@@ -1,9 +1,9 @@
 Template: mini-buildd/purge_warning
 Type: note
-_Description: Data purge warning
+_Description: mini-buildd data purge warning
  You have chosen to purge mini-buildd.
  .
- This choice means that the mini-buildd user will be removed
+ As a consequence, the mini-buildd user will be removed
  along with all the files it owns, possibly including Debian
  repositories.
  .
@@ -13,39 +13,38 @@
 Type: string
 Default: /var/lib/mini-buildd
 _Description: Home path:
- This is mini-buildd's UNIX user home, and the place where all
- data is kept. This path should have enough space for all
- repositories and/or builders data you plan to use.
+ Please choose the directory where mini-buildd data will be stored.
+ The directory will also be the home directory for the mini-buildd user.
+ .
+ It should have enough space for all the builders and repositories
+ you plan to use.
 
 Template: mini-buildd/admin_password
 Type: password
-_Description: Administrator's password:
- You may later login into the admin area of the web application
- via user 'admin' and the password you give here.
+_Description: Administrator password for mini-buildd:
+ Please choose the password for the administrative user of
+ mini-buildd. This password will be used for the "admin" user
+ in mini-buildd's web interface.
  .
- Entering a password will also trigger the (needed) initial
- creation of the 'admin' user.
+ If you enter a password, this will also trigger the creation of a
+ local "admin" user.
  .
- If you leave this empty, nothing will be done.
+ If you leave this empty, no user creation will happen.
 
 Template: mini-buildd/options
 Type: string
 Default: --verbose
 _Description: Extra options:
- You may add any mini-buildd command line option here (see
- 'mini-buildd --help').
+ Please add any mini-buildd command line options you would like to use
+ ("mini-buildd --help" gives a list of available options).
  .
- However, the only really recommended option to give here is to
- increase/decrease the log level via '-v, --verbose' or '-q,
- --quiet', respectively.
+ The only options really recommended for use here are "-v"/"--verbose"
+ to increase the log level or "-q"/"--quiet" to decrease it.
 
 Template: mini-buildd/note
 Type: note
-_Description: Package configuration complete
- After the package installation is complete, visit the new home
- of your local mini-build instance. Unless you changed the
- defaults, this should be reachable via:
- .
- http://localhost:8066
+_Description: Configuration of mini-buildd complete
+ Unless you changed the defaults, you should now be able to visit the
+ new home of the local mini-buildd instance at http://localhost:8066.
  .
- A good starting point is the online manual's Quickstart.
+ A good starting point is the online manual named "Quickstart".
Template: mini-buildd/purge_warning
Type: note
_Description: mini-buildd data purge warning
 You have chosen to purge mini-buildd.
 .
 As a consequence, the mini-buildd user will be removed
 along with all the files it owns, possibly including Debian
 repositories.
 .
 To keep this data, you need to back it up now.

Template: mini-buildd/home
Type: string
Default: /var/lib/mini-buildd
_Description: Home path:
 Please choose the directory where mini-buildd data will be stored.
 The directory will also be the home directory for the mini-buildd user.
 .
 It should have enough space for all the builders and repositories
 you plan to use.

Template: mini-buildd/admin_password
Type: password
_Description: Administrator password for mini-buildd:
 Please choose the password for the administrative user of
 mini-buildd. This password will be used for the "admin" user
 in mini-buildd's web interface.
 .
 If you enter a password, this will also trigger the creation of a
 local "admin" user.
 .
 If you leave this empty, no user creation will happen.

Template: mini-buildd/options
Type: string
Default: --verbose
_Description: Extra options:
 Please add any mini-buildd command line options you would like to use
 ("mini-buildd --help" gives a list of available options).
 .
 The only options really recommended for use here are "-v"/"--verbose"
 to increase the log level or "-q"/"--quiet" to decrease it.

Template: mini-buildd/note
Type: note
_Description: Configuration of mini-buildd complete
 Unless you changed the defaults, you should now be able to visit the
 new home of the local mini-buildd instance at http://localhost:8066.
 .
 A good starting point is the online manual named "Quickstart".
Source: mini-buildd
Section: devel
Priority: extra
Maintainer: Stephan Sürken <absurd@debian.org>
X-Python-Version: >=2.6
Build-Depends: debhelper (>= 8.1.0~),
               man-db (>= 2.5.1),
               po-debconf,
               python (>= 2.6.6-3~),
               python-setuptools,
               python-sphinx (>= 1.0.7+dfsg),
               python-pygraphviz,
               help2man,
               python-argparse,
               python-argcomplete (>= 0.5.4),
               python-keyring (>= 1.6),
               python-daemon (>= 1.5.5),
               python-debian (>= 0.1.18~),
               python-cherrypy3,
               python-pyftpdlib,
               python-django (>= 1.4),
               python-django-extensions (>= 0.4),
               python-django-registration (>= 0.9~)
Standards-Version: 3.9.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
Homepage: http://mini-buildd.installiert.net/

Package: python-mini-buildd
Section: python
Architecture: all
Depends: ${misc:Depends},
         ${python:Depends},
         python-argparse,
         python-argcomplete (>= 0.5.4),
         python-keyring (>= 1.6),
         python-debian (>= 0.1.18~)
Description: minimal build daemon - python library and user tool
 Mini-buildd is an easy-to-configure autobuilder and
 repository for deb packages.
 .
 This package includes the control utility "mini-buildd-tool" along
 with the "mini_buildd" Python package.

Package: mini-buildd
Architecture: all
Depends: ${misc:Depends},
         ${python:Depends},
         ${sphinxdoc:Depends},
         python-mini-buildd (= ${binary:Version}),
         mini-buildd-common (= ${binary:Version}),
         python-daemon (>= 1.5.5),
         python-cherrypy3,
         python-pyftpdlib,
         python-django (>= 1.4),
         python-django-extensions (>= 0.4),
         python-django-registration (>= 0.9~),
         libjs-jquery,
         adduser,
         sudo,
         gnupg,
         reprepro (>= 4.2),
         debootstrap (>= 1.0.24~),
         schroot (>= 1.6.3),
         sbuild (>= 0.63.1),
         dpkg-dev,
         lintian,
         devscripts (>= 2.10.15)
Recommends: python-apt
Suggests: haveged, lvm2, qemu-user-static, binfmt-support
Breaks: mini-buildd-rep (<< 1.0.0~),
        mini-buildd-bld (<< 1.0.0~)
Replaces: mini-buildd-rep,
          mini-buildd-bld
Description: minimal build daemon - daemon
 Mini-buildd is an easy-to-configure autobuilder and
 repository for deb packages.
 .
 This package provides the main daemon.

Package: mini-buildd-common
Architecture: all
Depends: ${misc:Depends}
Description: minimal build daemon - 08x upgrade dummy package
 This is a dummy package assuring mini-buildd-common is
 upgraded (as a possible purge of the 0.8.x package
 would badly break mini-buildd 1.0).

Reply to: