Re: [RFR] templates://ucf/{templates.master}
Christian Perrier wrote:
> Please find, for review, the debconf templates of ucf.
This one doesn't need much work at all.
> Template: ucf/changeprompt
...
> + A new version of the ${FILE} configuration file is available, but the local
> + copy has been modified.
>
> I think that "new version of configuration file ${FILE}" with the name
> of the file following 'configuration file' is less correct than my proposal.
If it's a "title" (like "fstab") being used in passing then your
order is often better, but when you're introducing a file by giving
its full URI it seems more natural the other way round. I suppose
it's in apposition, like "the river Nile" or even "my friend John
Doe". It could go even further to the right:
A new version is available of the configuration file ${FILE}, but the local
copy has been modified.
But probably not.
> -Description: Update Configuration File: preserves user changes to config files.
> - Debian policy states that configuration files must preserve user
> - changes during package upgrade. The easy way to achieve this behavior
> - is to make the configuration file a `conffile', in which case dpkg
> +Description: preservation of user changes to configuration files
>
> I think it's more important to give the package's rationale than
> explain the acronym. Also avoids a leading capital which is discouraged.
Policy only says that sentential capitalisation is unnecessary, not
that lexical uppercase is forbidden. Still, I'm happy with the
result.
> + The Debian policy states that configuration files must preserve user
> + changes during package upgrades. The easy way to achieve this behavior
> + is to make the configuration file a 'conffile', in which case dpkg
>
> "The" Debian policy
"The policy" is one specific rule, "policy" is the system of rules
as a whole (like "Science says..." or "Logic dictates..."). Since
we haven't mentioned which rule we're talking about, it makes more
sense to leave out the article. In fact I notice I did exactly that
in my previous paragraph.
--
JBR
Ankh kak! (Ancient Egyptian blessing)
--- ../ucf.old/debian/templates.master 2007-05-05 18:03:25.000000000 +0100
+++ debian/templates.master 2007-05-15 17:58:06.000000000 +0100
@@ -5,21 +5,23 @@
Template: ucf/changeprompt_threeway
Type: select
-__Choices: install the package maintainer's version, keep your currently-installed version, show the differences between the versions, show a side-by-side difference between the versions, show a 3 way difference between available versions of the file, do a 3 way merge between available versions of the file [Very Experimental], start a new shell to examine the situation
-Default: keep your currently-installed version
-_Description: What would you like to do about ${BASENAME}?
- A new version of configuration file ${FILE} is available, but your version
- has been locally modified.
+# Translators, please keep translations *short* (less than 65 columns)
+__Choices: install the package maintainer's version, keep the currently installed version, show the differences between the versions, show a side-by-side difference between the versions, show a 3-way difference between available versions, do a 3-way merge between available versions (experimental), start a new shell to examine the situation
+Default: keep the currently installed version
+_Description: Action for ${BASENAME}:
+ A new version of the configuration file ${FILE} is available, but the local
+ copy has been modified.
Template: ucf/changeprompt
Type: select
-__Choices: install the package maintainer's version, keep your currently-installed version, show the differences between the versions, show a side-by-side difference between the versions, start a new shell to examine the situation
-Default: keep your currently-installed version
-_Description: What would you like to do about ${BASENAME}?
- A new version of configuration file ${FILE} is available, but your version
- has been locally modified.
+__Choices: install the package maintainer's version, keep the currently installed version, show the differences between the versions, show a side-by-side difference between the versions, start a new shell to examine the situation
+Default: keep the currently installed version
+_Description: Action for ${BASENAME}:
+ A new version of the configuration file ${FILE} is available, but the local
+ copy has been modified.
Template: ucf/show_diff
Type: note
-_Description: The differences
+#flag:translate!:2
+_Description: File differences
${DIFF}
--- ../ucf.old/debian/control 2007-05-05 18:03:25.000000000 +0100
+++ debian/control 2007-05-15 17:57:04.000000000 +0100
@@ -11,31 +11,31 @@
Architecture: all
Depends: debconf (>= 1.4.72) | debconf-2.0, coreutils (>= 5.91)
Recommends: debconf-utils
-Description: Update Configuration File: preserves user changes to config files.
+Description: preservation of user changes to configuration files
Debian policy states that configuration files must preserve user
- changes during package upgrade. The easy way to achieve this behavior
- is to make the configuration file a `conffile', in which case dpkg
+ changes during package upgrades. The easy way to achieve this behavior
+ is to make the configuration file a 'conffile', in which case dpkg
handles the file specially during upgrades, prompting the user as
needed.
.
This is appropriate only if it is possible to distribute a default
version that will work for most installations, although some system
- administrators may choose to modify it. This implies that the
+ administrators may choose to modify it. This implies that the
default version will be part of the package distribution, and must
not be modified by the maintainer scripts during installation (or at
any other time).
.
- This script attempts to provide conffile like handling for files that
+ This script attempts to provide conffile-like handling for files that
can not be labelled conffiles, are not shipped in a Debian package,
- but handled by the postinst instead. This script allows one to
+ but handled by the postinst instead. This script allows one to
maintain files in /etc, preserving user changes and in general
offering the same facilities while upgrading that dpkg normally
- provides for "conffiles".
+ provides for 'conffiles'.
.
Additionally, this script provides facilities for transitioning a
- file that had not been provided conffile like protection to come
+ file that had not been provided with conffile-like protection to come
under this schema, and attempts to minimize questions asked at
- install time. Indeed, the transitioning facility is better than the
+ installation time. Indeed, the transitioning facility is better than the
one offered by dpkg while transitioning a file from a non-conffile to
conffile status.
Template: ucf/title
Type: title
_Description: Modified configuration file
Template: ucf/changeprompt_threeway
Type: select
# Translators, please keep translations *short* (less than 65 columns)
__Choices: install the package maintainer's version, keep the currently installed version, show the differences between the versions, show a side-by-side difference between the versions, show a 3-way difference between available versions, do a 3-way merge between available versions (experimental), start a new shell to examine the situation
Default: keep the currently installed version
_Description: Action for ${BASENAME}:
A new version of the configuration file ${FILE} is available, but the local
copy has been modified.
Template: ucf/changeprompt
Type: select
__Choices: install the package maintainer's version, keep the currently installed version, show the differences between the versions, show a side-by-side difference between the versions, start a new shell to examine the situation
Default: keep the currently installed version
_Description: Action for ${BASENAME}:
A new version of the configuration file ${FILE} is available, but the local
copy has been modified.
Template: ucf/show_diff
Type: note
#flag:translate!:2
_Description: File differences
${DIFF}
Source: ucf
XS-VCS-Arch: http://arch.debian.org/arch/private/srivasta/grab/ucf
XS-VCS-Browse: http://arch.debian.org/cgi-bin/archzoom.cgi/srivasta@debian.org--lenny/ucf?expand
Section: utils
Priority: optional
Maintainer: Manoj Srivastava <srivasta@debian.org>
Build-Depends-Indep: po-debconf, gettext
Standards-Version: 3.7.2.0
Package: ucf
Architecture: all
Depends: debconf (>= 1.4.72) | debconf-2.0, coreutils (>= 5.91)
Recommends: debconf-utils
Description: preservation of user changes to configuration files
Debian policy states that configuration files must preserve user
changes during package upgrades. The easy way to achieve this behavior
is to make the configuration file a 'conffile', in which case dpkg
handles the file specially during upgrades, prompting the user as
needed.
.
This is appropriate only if it is possible to distribute a default
version that will work for most installations, although some system
administrators may choose to modify it. This implies that the
default version will be part of the package distribution, and must
not be modified by the maintainer scripts during installation (or at
any other time).
.
This script attempts to provide conffile-like handling for files that
can not be labelled conffiles, are not shipped in a Debian package,
but handled by the postinst instead. This script allows one to
maintain files in /etc, preserving user changes and in general
offering the same facilities while upgrading that dpkg normally
provides for 'conffiles'.
.
Additionally, this script provides facilities for transitioning a
file that had not been provided with conffile-like protection to come
under this schema, and attempts to minimize questions asked at
installation time. Indeed, the transitioning facility is better than the
one offered by dpkg while transitioning a file from a non-conffile to
conffile status.
Reply to: