Hi, Please find, for review, the debconf templates and packages descriptions for the citadel source package. This review will last from Monday, August 27, 2012 to Wednesday, September 05, 2012. 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, a summary will be sent to the review bug report, and a mail will be sent to this list with "[BTS]" as a subject tag. Rationale: > diff --git a/git-stuff.templates b/git-stuff.templates > index f34c0dd..07bb4bf 100644 > --- a/git-stuff.templates > +++ b/git-stuff.templates > @@ -1,43 +1,38 @@ > Template: git-repack-repositories/title > Type: title > -Description: Git Repack Repositories > +_Description: Git repack repositories Add the translatable mark (as in every following _Description). Lowercase the words. If you prefer uppercase (since it's a title), so should the “Additional Git utilities” titles bellow for consistency. > Template: git-repack-repositories/enable > Type: boolean > Default: false > -Description: Git repack: > - Git repositories tend to grow quite large quickly. From time to time, you > - have to repack the repositories to save space and keep optimal > +_Description: Do you want to enable the cron job? > + Git repositories tend to grow quite large quickly. From time to time, > + the repositories should be repacked to save space and keep optimal > performances (by not having too many of files in the objects > subdirectory). > - . > - Do you want to enable the cron job? Move the question where it belongs (it will be displayed just before the boolean choice). Avoid the “you” form, because the reader/admin may not be the one who actually take care of the repack (and if I understood correctly the purpose of the cron job, “I” should not bother anymore to take core of that once setup things correctly). > Template: git-repack-repositories/directories > Type: string > Default: /srv/git > -Description: Git directories: > - Please specify the directory or directories (space separated) that is used > - as root for the Git repositories on your server. Note that > +_Description: Git directories: > + Please specify the directory or directories (space separated) used > + as root for the Git repositories on the server. Note that > git-repack-repositories will work recursively. I may be mistaken here, but “the directory or directories” doesn't sound like a singular subject, and this shorter proposal should allow to not even bother answering that question. Also avoid “your server”: many administrators don't install and setup stuff on their server (anyway, “the server” is neutral and should fit most if not all cases). > Template: git-repack-repositories/cron > Type: string > Default: @monthly > -Description: Git cron: > - What times should the cron job be started? Please refer to crontab(5) for > - the format definition. The default or if left empty will set the interval > - to '@monthly' (without the quotes) which means it gets executed every > +_Description: When should the cron job be started? > + Please refer to crontab(5) for the format definition. By default, > + '@monthly' (without quotes), means the cron job gets executed every > beginning of the month at midnight. Move the question where it belongs. s/What times/When/ that should fit better. Twist the “default” explanation, since the crontab defaults can also be overwritten by the admin. It may be twist even further, without stating in the text that “@monthly” is the default, since it's already visible (thanks to “Default: @monthly”). > Template: git-stuff/title > Type: title > -Description: additional Git utilities > +_Description: Additional Git utilities Add an uppercase for the first word of the title (see first remark). > Template: git-stuff/bash-profile > Type: boolean > Default: false > -Description: Shortcuts for Bash (/etc/profile.d) > - Should special shortcut definitions for Bash be activated in /etc/profile.d? > - . > - If unsure, say no. > +_Description: Should shortcut definitions be activated? > + Special shortcut definitions for Bash can be activated in /etc/profile.d. Move the question where it belongs, and shorten it since it will be displayed after the long description. Maybe something more descriptive could be useful in the long description, I Hope Daniel may enlighten us about this. Drop “If unsure, say no.”: it's already covered by “Default: false”, and it assumes a specific debconf interface where boolean question are answered with “yes” or “no”, while it can be setup otherwise (and most of us don't use vocal synthesis ;). Other members of the list may have other remarks and improvements to propose, thus this formal call for review. Thanks in advance. Regards David
diff --git a/git-stuff.templates b/git-stuff.templates index f34c0dd..07bb4bf 100644 --- a/git-stuff.templates +++ b/git-stuff.templates @@ -1,43 +1,38 @@ Template: git-repack-repositories/title Type: title -Description: Git Repack Repositories +_Description: Git repack repositories Template: git-repack-repositories/enable Type: boolean Default: false -Description: Git repack: - Git repositories tend to grow quite large quickly. From time to time, you - have to repack the repositories to save space and keep optimal +_Description: Do you want to enable the cron job? + Git repositories tend to grow quite large quickly. From time to time, + the repositories should be repacked to save space and keep optimal performances (by not having too many of files in the objects subdirectory). - . - Do you want to enable the cron job? Template: git-repack-repositories/directories Type: string Default: /srv/git -Description: Git directories: - Please specify the directory or directories (space separated) that is used - as root for the Git repositories on your server. Note that +_Description: Git directories: + Please specify the directory or directories (space separated) used + as root for the Git repositories on the server. Note that git-repack-repositories will work recursively. Template: git-repack-repositories/cron Type: string Default: @monthly -Description: Git cron: - What times should the cron job be started? Please refer to crontab(5) for - the format definition. The default or if left empty will set the interval - to '@monthly' (without the quotes) which means it gets executed every +_Description: When should the cron job be started? + Please refer to crontab(5) for the format definition. By default, + '@monthly' (without quotes), means the cron job gets executed every beginning of the month at midnight. Template: git-stuff/title Type: title -Description: additional Git utilities +_Description: Additional Git utilities Template: git-stuff/bash-profile Type: boolean Default: false -Description: Shortcuts for Bash (/etc/profile.d) - Should special shortcut definitions for Bash be activated in /etc/profile.d? - . - If unsure, say no. +_Description: Should shortcut definitions be activated? + Special shortcut definitions for Bash can be activated in /etc/profile.d.
Template: git-repack-repositories/title Type: title _Description: Git repack repositories Template: git-repack-repositories/enable Type: boolean Default: false _Description: Do you want to enable the cron job? Git repositories tend to grow quite large quickly. From time to time, the repositories should be repacked to save space and keep optimal performances (by not having too many of files in the objects subdirectory). Template: git-repack-repositories/directories Type: string Default: /srv/git _Description: Git directories: Please specify the directory or directories (space separated) used as root for the Git repositories on the server. Note that git-repack-repositories will work recursively. Template: git-repack-repositories/cron Type: string Default: @monthly _Description: When should the cron job be started? Please refer to crontab(5) for the format definition. By default, '@monthly' (without quotes), means it gets executed every beginning of the month at midnight. Template: git-stuff/title Type: title _Description: Additional Git utilities Template: git-stuff/bash-profile Type: boolean Default: false _Description: Should shortcut definitions be activated? Special shortcut definitions for Bash can be activated in /etc/profile.d.
Source: git-stuff
Section: misc
Priority: optional
Maintainer: Daniel Baumann <daniel.baumann@progress-technologies.net>
Uploaders: Andrew Lee (æ??å?¥ç§?) <ajqlee@debian.org>
Build-Depends: debhelper (>= 9)
Standards-Version: 3.9.3
Package: git-stuff
Architecture: all
Depends: ${misc:Depends}, git
Recommends: cron, git-buildpackage, mr, pristine-tar
Description: additional Git utilities
This is a growing collection of tools for the Git Version Control System.
.
Currently the following tools have been documented:
.
* git-amend-all: adds all untracked files and amend all changes to the last
commit.
* git-checkout-branches: checks out all remote branches.
* git-cherry-pick-recursive: does a cherry-pick for a commit and each all its
children.
* git-commit-lazy: creates a new commit with all untracked files and changes.
* git-debian-add: creates a new commit and tag with all untracked files and
changes as new debian version.
* git-debian-changelog: creates a new section in debian/changelog with all
entries since the last release.
* git-whoami: tells about author and committer information.
Attachment:
signature.asc
Description: OpenPGP digital signature