[request-tracker-maintainers] [RFR] templates://rt-extension-assettracker/{templates}

Wed Jun 8 19:00:02 UTC 2011

Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.

It was almost perfect, and yet look how much I've changed...

>  _Description: Permission to modify the Request Tracker database:
>   Asset Tracker needs some modifications in the Request Tracker
>   database to be functional. These modifications can be made

Borderline ambiguous; "X needs Y to be functional" can mean "X
requires that Y is functional".  We could avoid that by saying
something like:

    For the Asset Tracker to be functional, some modifications are
    needed in the Request Tracker database.

The next template is similarly phrased, but not ambiguous, so I'm not
sure what to do... oh well, I'll modify both so the translators can
recycle text ("For the Asset Tracker to be functional, new tables must
be created in the Request Tracker database.")

> - automatically or you may be prompted when they are needed.
> - Alternatively, you can run the necessary commands manually.
> + automatically (choose "allow") or you may be prompted when they are
> + needed (choose "prompt").

"May" sounds as if it's an unpredictable hazard - use "can" (or
rephrase it as below).

> + Alternatively, you can run the necessary commands manually (choose "deny").

Is it worth rephrasing to make it more clearly a single three-way
choice?
                                             Choose "allow" to have
    these modifications performed automatically, "prompt" to be
    prompted when they are needed, or "deny" if you intend to run the
    necessary commands manually.

> - The full output should be available in the RT log, most probably
> + The full output should be available in Request Tracker log, most probably
>   syslog.

You've lost an article.

>   .
>   You can retry the modification, abort the installation or ignore the
                                                          ^,
Add comma.

Then the package description:

>  Package: rt3.8-extension-assettracker
>  Architecture: all
>  Depends: ${shlibs:Depends}, ${misc:Depends}, request-tracker3.8 (>= 3.8.1), libset-scalar-perl, libxml-parser-perl, libxml-simple-perl
> -Description: Asset tracking extension for Request Tracker
> - Asset Tracker is an extension for Request Tracker. It add the
> +Description: asset tracking extension for Request Tracker
> + Asset Tracker is an extension for Request Tracker. It adds the
>   ability to track assets in the same way one tracks tickets.

One can bypass the slightly stilted pronoun "one" here:

    ability to track assets in the same way as tickets.

-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
Source: rt-extension-assettracker
Section: perl
Priority: optional
Maintainer: Debian Request Tracker Group <pkg-request-tracker-maintainers at lists.alioth.debian.org>
Uploaders: Bradley Bell <btb at debian.org>
Build-Depends: debhelper (>= 7.0.50~)
Standards-Version: 3.9.2
Homepage: https://github.com/chakatodd/rt-extension-assettracker
Vcs-Git: git://git.debian.org/pkg-request-tracker/rt-extension-assettracker.git
Vcs-Browser: http://git.debian.org/?p=pkg-request-tracker/rt-extension-assettracker.git

Package: rt3.8-extension-assettracker
Architecture: all
Depends: ${shlibs:Depends}, ${misc:Depends}, request-tracker3.8 (>= 3.8.1), libset-scalar-perl, libxml-parser-perl, libxml-simple-perl
Description: asset tracking extension for Request Tracker
 Asset Tracker is an extension for Request Tracker. It adds the
 ability to track assets in the same way as tickets.
-------------- next part --------------
Template: rt3.8-extension-assettracker/modify-database-permission
Type: select
__Choices: allow, prompt, deny
Default: allow
_Description: Permission to modify the Request Tracker database:
 For the Asset Tracker to be functional, some modifications are
 needed in the Request Tracker database. Choose "allow" to have
 these modifications performed automatically, "prompt" to be
 prompted when they are needed, or "deny" if you intend to run the
 necessary commands manually.
 .
 Please check the README.Debian file for more details.

Template: rt3.8-extension-assettracker/setup-database-prompt
Type: boolean
Default: true
_Description: Set up the Request Tracker database?
 For the Asset Tracker to be functional, new tables must be created in
 the Request Tracker database.

Template: rt3.8-extension-assettracker/upgrade-database-prompt
Type: boolean
Default: true
_Description: Upgrade the Request Tracker database?
 The Request Tracker database schema and contents must be upgraded for
 this version of Asset Tracker.

Template: rt3.8-extension-assettracker/modify-database-error
Type: select
__Choices: abort, retry, ignore
Default: abort
#flag:translate!:3
_Description: Action after database modification error:
 An error occurred while modifying the database:
 .
 ${error}
 .
 The full output should be available in the Request Tracker log, most
 probably syslog.
 .
 You can retry the modification, abort the installation, or ignore the
 error. If you abort the installation, the operation will fail and you
 will need to manually intervene (for instance by purging and
 reinstalling). If you choose to ignore the error, the upgrade process
 will continue.
-------------- next part --------------
diff -ru old/control new/control

--- old/control	2011-06-07 19:48:13.786538532 +0100
+++ new/control	2011-06-08 19:53:04.242538595 +0100
@@ -12,6 +12,6 @@
 Package: rt3.8-extension-assettracker
 Architecture: all
 Depends: ${shlibs:Depends}, ${misc:Depends}, request-tracker3.8 (>= 3.8.1), libset-scalar-perl, libxml-parser-perl, libxml-simple-perl
-Description: Asset tracking extension for Request Tracker
- Asset Tracker is an extension for Request Tracker. It add the
- ability to track assets in the same way one tracks tickets.
+Description: asset tracking extension for Request Tracker
+ Asset Tracker is an extension for Request Tracker. It adds the
+ ability to track assets in the same way as tickets.
diff -ru old/templates new/templates
--- old/templates	2011-06-07 19:48:12.482871944 +0100
+++ new/templates	2011-06-08 19:58:18.978871994 +0100
@@ -3,10 +3,11 @@
 __Choices: allow, prompt, deny
 Default: allow
 _Description: Permission to modify the Request Tracker database:
- Asset Tracker needs some modifications in the Request Tracker
- database to be functional. These modifications can be made
- automatically or you may be prompted when they are needed.
- Alternatively, you can run the necessary commands manually.
+ For the Asset Tracker to be functional, some modifications are
+ needed in the Request Tracker database. Choose "allow" to have
+ these modifications performed automatically, "prompt" to be
+ prompted when they are needed, or "deny" if you intend to run the
+ necessary commands manually.
  .
  Please check the README.Debian file for more details.
 
@@ -14,8 +15,8 @@
 Type: boolean
 Default: true
 _Description: Set up the Request Tracker database?
- New tables must be created in the Request Tracker database for Asset
- Tracker to be functional.
+ For the Asset Tracker to be functional, new tables must be created in
+ the Request Tracker database.
 
 Template: rt3.8-extension-assettracker/upgrade-database-prompt
 Type: boolean
@@ -34,10 +35,10 @@
  .
  ${error}
  .
- The full output should be available in the RT log, most probably
- syslog.
+ The full output should be available in the Request Tracker log, most
+ probably syslog.
  .
- You can retry the modification, abort the installation or ignore the
+ You can retry the modification, abort the installation, or ignore the
  error. If you abort the installation, the operation will fail and you
  will need to manually intervene (for instance by purging and
  reinstalling). If you choose to ignore the error, the upgrade process
