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

[RFR] templates://apt-listchanges/{templates}



Please find, for review, the debconf templates and packages descriptions for the apt-listchanges source package.

This review will last from Tuesday, November 27, 2007 to Friday, December 07, 2007.

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:
--- ../apt-listchanges.old/debian/templates	2007-11-24 08:11:54.270251200 +0000
+++ debian/templates	2007-11-26 17:51:40.652942346 +0000
@@ -3,60 +3,57 @@
 __Choices: pager, gtk, browser, xterm-pager, xterm-browser, text, mail, none
 Default: pager
 _Description: Method for changes display:
- apt-listchanges can display package changes in a number of different
- ways.
+ Package changes may be displayed by apt-listchanges
+ in a number of different ways.

Sentence changed to avoid a leading lowercase letter

  .
-  pager         : use your preferred pager to display changes one page at
-                  a time;
-  gtk           : Display changes in a Gtk window;
-  browser       : display HTML-formatted changes using a web browser;
-  xterm-pager   : like pager, but in an xterm in the background;
-  xterm-browser : like browser, but in an xterm in the background;
-  text          : print changes to your terminal (without pausing);
-  mail          : only send changes via mail;
-  none          : do not run automatically from apt.
+  pager        : display changes one page at a time;

Attempt to use one line only. That template is already quite large and
it's better to have it fit on one screen.

+  gtk          : Display changes in a GTK window;
+  browser      : display HTML-formatted changes using a web browser;
+  xterm-pager  : like pager, but in an xterm in the background;
+  xterm-browser: like browser, but in an xterm in the background;

Unfrenchify the use of colons, ie no space before the longest part,
therefore moving the line of colons one character left.

+  text         : print changes to the terminal (without pausing);
+  mail         : only send changes via mail;
+  none         : do not run automatically from apt.
  .
- This setting can be overridden by a command-line option or an environment
- variable.  Note that you can still send a copy via mail with all of the
- frontends except 'none'.
+ This setting can be overridden at execution time. A copy can be
+ additionnaly sent by mail with all frontends but 'none'.


Here again, this is an attemps to save space.
 
 Template: apt-listchanges/email-address
 Type: string
 Default: root
-_Description: E-mail Address(es) which will receive changes:
- apt-listchanges can email a copy of displayed changes.  Please enter
- the email address the changes should be sent to.
+_Description: E-mail address(es) which will receive changes:

Ungermanify

+ A copy of displayed changes can be sent by mail by apt-listchanges. Please
+ specify the email address the changes should be sent to.

Again, attempt to avoid a leading lowercase letter. Also remove double
spaces after sentencee dots (this is something we standardized on in
the reviews).

  .
- Multiple addresses may be specified, delimited by commas.  Leave this
- empty if you do not want any email to be sent.
+ Multiple addresses may be specified, delimited by commas. Leaving this
+ field empty disables mail notifications.


Slightly rephrase for a more factual wording (avoid the "do not want")
 
 Template: apt-listchanges/confirm
 Type: boolean
 Default: false
 _Description: Prompt for confirmation after displaying changes?
- After giving you a chance to read the list of changes, apt-listchanges
- can ask whether or not you would like to continue. This is useful when
- running from apt, as it gives you a chance to abort the upgrade if you see
- a change you do not want to apply (yet).
+ After displaying the list of changes, apt-listchanges may
+ prompt you to continue. This is useful when
+ running from apt, as it offer an opportunity to abort the upgrade in
+ case a change is not wisehd.

I'm not entirely happy with my proposal to reword the "can ask
whether...". We probably can find something better.

  .
  This setting does not apply to the 'mail' or 'none' frontends, and can be
- overridden with a command line option.
+ overridden at execution time.

Consistency with the wording I changed in the first template

 
 Template: apt-listchanges/save-seen
 Type: boolean
 Default: true
 _Description: Should apt-listchanges skip changes that have already been seen?
- apt-listchanges has the capability to keep track of which changes
- have already been displayed, and to skip them in future
- invocations. This is useful, for example, when retrying an upgrade.
+ A record of already displayed changes can be kept in order to avoid
+ displaying them again. This is useful, for example, when retrying an upgrade.

Yet another attempt to avoid a leading lowercase

 
 Template: apt-listchanges/which
 Type: select
-_Choices: news, both, changelogs
+__Choices: news, changelogs, both

Split "Choices" and reorder them to propose the "both" option at the
end which seems to make more sense.

 Default: news
 _Description: Changes displayed with apt:
  Please choose which type of changes should be displayed with APT.
  .
-  news - important news items only
-  both - both news and detailed changelogs
-  changelogs - detailed changelogs only
+  news      : important news items only;
+  changelogs: detailed changelogs only;
+  both      : both informations.

Justin: "informations" or "information"? I have a doubt.

Normalise the enumeration with the first template.


--- ../apt-listchanges.old/debian/control	2007-11-24 08:11:54.270251200 +0000
+++ debian/control	2007-11-26 17:54:42.643890378 +0000
@@ -16,13 +16,13 @@
  ucf (>= 0.28), debianutils (>= 2.0.2)
 Recommends: exim4 | mail-transport-agent, python-glade2, python-gtk2
 Suggests: x-terminal-emulator, www-browser
-Description: Display change history from .deb archives
- apt-listchanges is a tool to show what has been changed in a new
+Description: change history notification for .deb packages

Avoid a sentence (DevRef 6.2.2: Thou Shalt Not Make Sentences in Synopsis)

+ The apt-listchanges program is a tool that shows what has been changed in a new
  version of a Debian package, as compared to the version currently
- installed on the system.  It does this by extracting the relevant
+ installed on the system. It extracts the relevant

"It does this by"....I would have written that and, therefore, I
suspect this might be Frenglish..:)

  entries from the Debian changelog file, and the NEWS.Debian file.
  .
- It can be run on several .deb archives at a time to get a list of all
- of the changes that would be effected by installing or upgrading a
- group of packages.  It can be configured to do this automatically
+ It can be run on several packages at a time to get a list of all

s/.deb archives/packages: more natural?

+ changes that would happen by installing or upgrading a
+ group of packages. It can be configured to be executed once
  during upgrades using apt.

Here also, I suspect some Frenglish in the initial wording.

-- 


Template: apt-listchanges/frontend
Type: select
__Choices: pager, gtk, browser, xterm-pager, xterm-browser, text, mail, none
Default: pager
_Description: Method for changes display:
 Package changes may be displayed by apt-listchanges
 in a number of different ways.
 .
  pager        : display changes one page at a time;
  gtk          : Display changes in a GTK window;
  browser      : display HTML-formatted changes using a web browser;
  xterm-pager  : like pager, but in an xterm in the background;
  xterm-browser: like browser, but in an xterm in the background;
  text         : print changes to the terminal (without pausing);
  mail         : only send changes via mail;
  none         : do not run automatically from apt.
 .
 This setting can be overridden at execution time. A copy can be
 additionnaly sent by mail with all frontends but 'none'.

Template: apt-listchanges/email-address
Type: string
Default: root
_Description: E-mail address(es) which will receive changes:
 A copy of displayed changes can be sent by mail by apt-listchanges. Please
 specify the email address the changes should be sent to.
 .
 Multiple addresses may be specified, delimited by commas. Leaving this
 field empty disables mail notifications.

Template: apt-listchanges/confirm
Type: boolean
Default: false
_Description: Prompt for confirmation after displaying changes?
 After displaying the list of changes, apt-listchanges may
 prompt you to continue. This is useful when
 running from apt, as it offer an opportunity to abort the upgrade in
 case a change is not wisehd.
 .
 This setting does not apply to the 'mail' or 'none' frontends, and can be
 overridden at execution time.

Template: apt-listchanges/save-seen
Type: boolean
Default: true
_Description: Should apt-listchanges skip changes that have already been seen?
 A record of already displayed changes can be kept in order to avoid
 displaying them again. This is useful, for example, when retrying an upgrade.

Template: apt-listchanges/which
Type: select
__Choices: news, changelogs, both
Default: news
_Description: Changes displayed with apt:
 Please choose which type of changes should be displayed with APT.
 .
  news      : important news items only;
  changelogs: detailed changelogs only;
  both      : both informations.
--- apt-listchanges.old/debian/templates	2007-11-24 08:11:54.270251200 +0000
+++ apt-listchanges/debian/templates	2007-11-27 06:43:12.559290634 +0000
@@ -3,60 +3,57 @@
 __Choices: pager, gtk, browser, xterm-pager, xterm-browser, text, mail, none
 Default: pager
 _Description: Method for changes display:
- apt-listchanges can display package changes in a number of different
- ways.
+ Package changes may be displayed by apt-listchanges
+ in a number of different ways.
  .
-  pager         : use your preferred pager to display changes one page at
-                  a time;
-  gtk           : Display changes in a Gtk window;
-  browser       : display HTML-formatted changes using a web browser;
-  xterm-pager   : like pager, but in an xterm in the background;
-  xterm-browser : like browser, but in an xterm in the background;
-  text          : print changes to your terminal (without pausing);
-  mail          : only send changes via mail;
-  none          : do not run automatically from apt.
+  pager        : display changes one page at a time;
+  gtk          : Display changes in a GTK window;
+  browser      : display HTML-formatted changes using a web browser;
+  xterm-pager  : like pager, but in an xterm in the background;
+  xterm-browser: like browser, but in an xterm in the background;
+  text         : print changes to the terminal (without pausing);
+  mail         : only send changes via mail;
+  none         : do not run automatically from apt.
  .
- This setting can be overridden by a command-line option or an environment
- variable.  Note that you can still send a copy via mail with all of the
- frontends except 'none'.
+ This setting can be overridden at execution time. A copy can be
+ additionnaly sent by mail with all frontends but 'none'.
 
 Template: apt-listchanges/email-address
 Type: string
 Default: root
-_Description: E-mail Address(es) which will receive changes:
- apt-listchanges can email a copy of displayed changes.  Please enter
- the email address the changes should be sent to.
+_Description: E-mail address(es) which will receive changes:
+ A copy of displayed changes can be sent by mail by apt-listchanges. Please
+ specify the email address the changes should be sent to.
  .
- Multiple addresses may be specified, delimited by commas.  Leave this
- empty if you do not want any email to be sent.
+ Multiple addresses may be specified, delimited by commas. Leaving this
+ field empty disables mail notifications.
 
 Template: apt-listchanges/confirm
 Type: boolean
 Default: false
 _Description: Prompt for confirmation after displaying changes?
- After giving you a chance to read the list of changes, apt-listchanges
- can ask whether or not you would like to continue. This is useful when
- running from apt, as it gives you a chance to abort the upgrade if you see
- a change you do not want to apply (yet).
+ After displaying the list of changes, apt-listchanges may
+ prompt you to continue. This is useful when
+ running from apt, as it offer an opportunity to abort the upgrade in
+ case a change is not wisehd.
  .
  This setting does not apply to the 'mail' or 'none' frontends, and can be
- overridden with a command line option.
+ overridden at execution time.
 
 Template: apt-listchanges/save-seen
 Type: boolean
 Default: true
 _Description: Should apt-listchanges skip changes that have already been seen?
- apt-listchanges has the capability to keep track of which changes
- have already been displayed, and to skip them in future
- invocations. This is useful, for example, when retrying an upgrade.
+ A record of already displayed changes can be kept in order to avoid
+ displaying them again. This is useful, for example, when retrying an upgrade.
 
 Template: apt-listchanges/which
 Type: select
-_Choices: news, both, changelogs
+__Choices: news, changelogs, both
 Default: news
 _Description: Changes displayed with apt:
  Please choose which type of changes should be displayed with APT.
  .
-  news - important news items only
-  both - both news and detailed changelogs
-  changelogs - detailed changelogs only
+  news      : important news items only;
+  changelogs: detailed changelogs only;
+  both      : both informations.
--- apt-listchanges.old/debian/control	2007-11-24 08:11:54.270251200 +0000
+++ apt-listchanges/debian/control	2007-11-26 17:54:42.643890378 +0000
@@ -16,13 +16,13 @@
  ucf (>= 0.28), debianutils (>= 2.0.2)
 Recommends: exim4 | mail-transport-agent, python-glade2, python-gtk2
 Suggests: x-terminal-emulator, www-browser
-Description: Display change history from .deb archives
- apt-listchanges is a tool to show what has been changed in a new
+Description: change history notification for .deb packages
+ The apt-listchanges program is a tool that shows what has been changed in a new
  version of a Debian package, as compared to the version currently
- installed on the system.  It does this by extracting the relevant
+ installed on the system. It extracts the relevant
  entries from the Debian changelog file, and the NEWS.Debian file.
  .
- It can be run on several .deb archives at a time to get a list of all
- of the changes that would be effected by installing or upgrading a
- group of packages.  It can be configured to do this automatically
+ It can be run on several packages at a time to get a list of all
+ changes that would happen by installing or upgrading a
+ group of packages. It can be configured to be executed once
  during upgrades using apt.
Source: apt-listchanges
Section: utils
Priority: optional
Maintainer: Pierre Habouzit <madcoder@debian.org>
Uploaders: Matt Zimmerman <mdz@debian.org>
Standards-Version: 3.7.2
Vcs-Browser: http://git.madism.org/?p=apt-listchanges.git;a=summary
Vcs-Git: git://git.madism.org/apt-listchanges.git
Build-Depends: debhelper (>= 5)
Build-Depends-Indep: docbook-to-man, gettext, python-dev, po-debconf,
 python-support (>= 0.4.0), libexpat1-dev

Package: apt-listchanges
Architecture: all
Depends: ${python:Depends}, apt (>= 0.5.3), python-apt, debconf | debconf-2.0,
 ucf (>= 0.28), debianutils (>= 2.0.2)
Recommends: exim4 | mail-transport-agent, python-glade2, python-gtk2
Suggests: x-terminal-emulator, www-browser
Description: change history notification for .deb packages
 The apt-listchanges program is a tool that shows what has been changed in a new
 version of a Debian package, as compared to the version currently
 installed on the system. It extracts the relevant
 entries from the Debian changelog file, and the NEWS.Debian file.
 .
 It can be run on several packages at a time to get a list of all
 changes that would happen by installing or upgrading a
 group of packages. It can be configured to be executed once
 during upgrades using apt.

Attachment: signature.asc
Description: Digital signature


Reply to: