Re: [RFR] templates://apt-listchanges/{templates}
Christian Perrier wrote:
> Your review should be sent as an answer to this mail.
> + pager : display changes one page at a time;
> + gtk : Display changes in a GTK window;
display
> + 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;
(Strictly speaking these invoke x-terminal-emulator, not xterm, but
I've left that alone.)
> + text : print changes to the terminal (without pausing);
> + mail : only send changes via mail;
e-mail;
> + none : do not run automatically from apt.
APT.
(Throughout; apt is the package, APT is the package-management
system.)
And let's put 'gtk' after 'xterm-browser' rather than breaking up
the pager/browser/xterm-pager/xterm-browser sequence (with a
matching change to the __Choices: line).
> + This setting can be overridden at execution time. A copy can be
> + additionnaly sent by mail with all frontends but 'none'.
It's "additionally", but shorten it to "All frontends but 'none' can
also mail a copy".
> +_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.
Getting contorted. How about this aproach:
Optionally, apt-listchanges can e-mail a copy of displayed changes
to a specified address.
> + 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.
wished
> I'm not entirely happy with my proposal to reword the "can ask
> whether...". We probably can find something better.
It doesn't prompt *me* to continue... how about:
After displaying the list of changes, apt-listchanges may pause with a
confirmation prompt. This is useful when running from APT, as it
offers an opportunity to abort the upgrade if a change is unwelcome.
> Default: news
> _Description: Changes displayed with apt:
APT
> Please choose which type of changes should be displayed with APT.
> .
> + news : important news items only;
> + changelogs: detailed changelogs only;
> + both : both informations.
>
> Justin: "informations" or "information"? I have a doubt.
It would have to be "both kinds of information". But that's almost
as long as what it's abbreviating. Alternatively, "both" will work
without a noun... but we can't say "both: both".
news : important news items only;
changelogs: detailed changelogs only;
both : news and changelogs.
> -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)
I'm not sure about "s/.deb archives/.deb packages/", though.
They're Debian(-style) packages formatted as .deb files, which are
ar archives... it makes me want to avoid the issue:
Description: package change history notification tool
> + 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..:)
Probably I would have written "It achieves this", then noticed I was
being longwinded and cut it. I don't like "the foo program is a
tool that...", but I can't put my finger on why.
> entries from the Debian changelog file, and the NEWS.Debian file.
An odd way to put it when they're usually both foo.Debian files.
>From the top:
The tool apt-listchanges can compare a new version of a Debian package
with the one currently installed and show what has been changed, by
extracting the relevant entries from the Debian changelog and NEWS
files.
> - It can be run on several .deb archives at a time to get a list of all
> + It can be run on several packages at a time to get a list of all
>
> s/.deb archives/packages: more natural?
I think it would help to retain one reference to the .deb files
themselves here, to clarify that this is a commandline use case
("apt-listchanges -hv *.deb").
> + changes that would happen by installing or upgrading a
> + group of packages. It can be configured to be executed once
> during upgrades using apt.
Lots of minor niggles, leaving me with:
It can be run on several .deb archives at a time to get a list of all
changes that would be caused by installing or upgrading a group of
packages. When configured as an APT plugin it will do this automatically
during upgrades.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- ../apt-listchanges.old/debian/templates 2007-11-18 22:11:25.000000000 +0000
+++ debian/templates 2007-11-27 14:43:45.000000000 +0000
@@ -1,62 +1,58 @@
Template: apt-listchanges/frontend
Type: select
-__Choices: pager, gtk, browser, xterm-pager, xterm-browser, text, mail, none
+__Choices: pager, browser, xterm-pager, xterm-browser, gtk, 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;
+ 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;
+ gtk : display changes in a GTK window;
+ text : print changes to the terminal (without pausing);
+ mail : only send changes via e-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. All frontends but
+ 'none' can also mail a copy.
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:
+ Optionally, apt-listchanges can e-mail a copy of displayed changes
+ to a specified address.
.
- 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 pause with a
+ confirmation prompt. This is useful when running from APT, as it offers
+ an opportunity to abort the upgrade if a change is unwelcome.
.
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:
+_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 : news and changelogs.
--- ../apt-listchanges.old/debian/control 2007-11-18 22:40:00.000000000 +0000
+++ debian/control 2007-11-27 14:21:14.000000000 +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
- version of a Debian package, as compared to the version currently
- installed on the system. It does this by extracting the relevant
- entries from the Debian changelog file, and the NEWS.Debian file.
+Description: package change history notification tool
+ The tool apt-listchanges can compare a new version of a Debian package
+ with the one currently installed and show what has been changed, by
+ extracting the relevant entries from the Debian changelog and NEWS
+ files.
.
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
- during upgrades using apt.
+ changes that would be caused by installing or upgrading a group of
+ packages. When configured as an APT plugin it will do this automatically
+ during upgrades.
Template: apt-listchanges/frontend
Type: select
__Choices: pager, browser, xterm-pager, xterm-browser, gtk, 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;
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;
gtk : display changes in a GTK window;
text : print changes to the terminal (without pausing);
mail : only send changes via e-mail;
none : do not run automatically from APT.
.
This setting can be overridden at execution time. All frontends but
'none' can also mail a copy.
Template: apt-listchanges/email-address
Type: string
Default: root
_Description: E-mail address(es) which will receive changes:
Optionally, apt-listchanges can e-mail a copy of displayed changes
to a specified address.
.
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 pause with a
confirmation prompt. This is useful when running from APT, as it offers
an opportunity to abort the upgrade if a change is unwelcome.
.
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 : news and changelogs.
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: package change history notification tool
The tool apt-listchanges can compare a new version of a Debian package
with the one currently installed and show what has been changed, by
extracting the relevant entries from the Debian changelog and NEWS
files.
.
It can be run on several .deb archives at a time to get a list of all
changes that would be caused by installing or upgrading a group of
packages. When configured as an APT plugin it will do this automatically
during upgrades.
Reply to: