[Resolvconf-devel] [RFR] templates://resolvconf/{templates}

Christian Perrier bubulle at debian.org
Thu Jan 24 17:36:22 UTC 2008


Please find, for review, the debconf templates and packages descriptions for the resolvconf source package.

This review will last from Thursday, January 24, 2008 to Sunday, February 03, 2008.

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:
--- ../resolvconf.old/debian/templates	2008-01-18 06:22:38.669402447 +0100
+++ debian/templates	2008-01-22 18:59:23.165556615 +0100
@@ -2,55 +2,51 @@
 Type: boolean
 Default: true
 _Description: Prepare /etc/resolv.conf for dynamic updates?
- This package contains the infrastructure required for dynamic updating of
+ The resolvconf package contains the infrastructure required for dynamic updating of

Given that it is not always clear which package is being configured,
better re-add the package name

  the resolver configuration file. Part of the necessary infrastructure is
  a symbolic link from /etc/resolv.conf to /etc/resolvconf/run/resolv.conf.
- If you agree then this link will be created. The existing /etc/resolv.conf
+ If you choose this option, this link will be created. The existing /etc/resolv.conf

"choose this option" is the now de facto standardized way to say "if
you say yes"...:)

  file will be preserved as /etc/resolvconf/resolv.conf.d/original; it will
  be restored if this package is removed.
  .
- If you wish to prevent future installations from recreating the symbolic
- link then you can run dpkg-reconfigure later to withdraw your agreement.
- .
- If you do not agree then the necessary symbolic link will not be created
- and consequently your resolver configuration file will not be dynamically
- updated. In order to activate dynamic updating you will have to configure
- resolvconf manually following the straightforward instructions in the
- README file. If you choose not to configure resolvconf at all then you
- should remove the package because its presence causes some programs to
- deviate from their default behavior.
- .
- However you decide, you should read the README file.
+ Declining this option will prevent future installations from recreating
+ the symbolic link and the resolver configuration file will not be dynamically
+ updated. Dynamic updating can then be activated from instructions in the
+ README file.

This is an attempt to shorten that template down and keep chances to
have it fit in one screen.

Of course, that means isolating the main ideas and this is debatable.

 
 Template: resolvconf/downup-interfaces
 Type: note
-_Description: Remember to reconfigure network interfaces
+_Description: Network interfaces configuration mandatory

Avoid a sentence.

That template could be considered debconf abuse (I may even have
already reported this..:-))

  Once resolvconf is installed, interface configurers supply nameserver
  information to it (which it then makes available to the C Library resolver
  and to DNS caches). However, they do this only when they bring up interfaces.
  Therefore for resolvconf's nameserver information to be up to date after
- initial installation it is necessary to reconfigure interfaces --
- that is, to take them down and then to bring them up again -- and to restart
+ initial installation it is necessary to reconfigure interfaces (that is,
+ to take them down and then to bring them up again) and to restart
  DNS caches.

Use standard parenthese

 
 Template: resolvconf/link-tail-to-original
 Type: boolean
 Default: false
 _Description: Append original file to dynamic file?
- If your original static resolver configuration file (/etc/resolv.conf)
- contains nameserver addresses then those addresses should be listed on
+ If the original static resolver configuration file (/etc/resolv.conf)
+ contains nameserver addresses, those addresses should be listed on

Unpersonnalize (this is not "my" file...


  "dns-nameservers" lines in /etc/network/interfaces as described in the
- README. Until you have modified /etc/network/interfaces and reconfigured
- the affected interfaces resolvconf will not include those addresses in the
- dynamically generated resolver configuration file. Without those addresses
- you may have trouble resolving domain names. A TEMPORARY solution is to
- append the whole original resolver configuration file to the end of
+ README file. 
+ .
+ Until you have modified /etc/network/interfaces and reconfigured
+ the affected interfaces, resolvconf will not include those addresses in the
+ dynamically generated resolver configuration file. As a temporary
+ workaround, the whole original resolver configuration file may be
+ appended to the end of


Split the paragraph for improved readability. At the expense of
length, though.

  the dynamically generated file. This will be done if there is a symbolic
  link from /etc/resolvconf/resolv.conf.d/tail to
- /etc/resolvconf/resolv.conf.d/original. If you agree then this symbolic
+ /etc/resolvconf/resolv.conf.d/original.
+ .
+ If you choose this option, this symbolic
  link will be created, provided that no /etc/resolvconf/resolv.conf.d/tail
  already exists.

Split again.

  .
  After you have modified /etc/network/interfaces to add the required
- "dns-nameservers" lines you should point the
+ "dns-nameservers" lines, you should point the

Added comma

  /etc/resolvconf/resolv.conf.d/tail symbolic link to /dev/null.
--- ../resolvconf.old/debian/control	2008-01-18 06:22:38.669402447 +0100
+++ debian/control	2008-01-23 07:45:06.183436083 +0100
@@ -22,5 +22,5 @@
  information are: DNS caches, resolver libraries and the
  programs that use them.
  .
- This package may require some manual configuration.  Please
+ This package may require some manual configuration. Please
  read the README file for detailed instructions.

Removed double spaces, which we try to suggest everywhere even though
this may be debated by some people.

-- 


-------------- next part --------------
Template: resolvconf/linkify-resolvconf
Type: boolean
Default: true
_Description: Prepare /etc/resolv.conf for dynamic updates?
 The resolvconf package contains the infrastructure required for dynamic updating of
 the resolver configuration file. Part of the necessary infrastructure is
 a symbolic link from /etc/resolv.conf to /etc/resolvconf/run/resolv.conf.
 If you choose this option, this link will be created. The existing /etc/resolv.conf
 file will be preserved as /etc/resolvconf/resolv.conf.d/original; it will
 be restored if this package is removed.
 .
 Declining this option will prevent future installations from recreating
 the symbolic link and the resolver configuration file will not be dynamically
 updated. Dynamic updating can then be activated from instructions in the
 README file.

Template: resolvconf/downup-interfaces
Type: note
_Description: Network interfaces configuration mandatory
 Once resolvconf is installed, interface configurers supply nameserver
 information to it (which it then makes available to the C Library resolver
 and to DNS caches). However, they do this only when they bring up interfaces.
 Therefore for resolvconf's nameserver information to be up to date after
 initial installation it is necessary to reconfigure interfaces (that is,
 to take them down and then to bring them up again) and to restart
 DNS caches.

Template: resolvconf/link-tail-to-original
Type: boolean
Default: false
_Description: Append original file to dynamic file?
 If the original static resolver configuration file (/etc/resolv.conf)
 contains nameserver addresses, those addresses should be listed on
 "dns-nameservers" lines in /etc/network/interfaces as described in the
 README file. 
 .
 Until you have modified /etc/network/interfaces and reconfigured
 the affected interfaces, resolvconf will not include those addresses in the
 dynamically generated resolver configuration file. As a temporary
 workaround, the whole original resolver configuration file may be
 appended to the end of
 the dynamically generated file. This will be done if there is a symbolic
 link from /etc/resolvconf/resolv.conf.d/tail to
 /etc/resolvconf/resolv.conf.d/original.
 .
 If you choose this option, this symbolic
 link will be created, provided that no /etc/resolvconf/resolv.conf.d/tail
 already exists.
 .
 After you have modified /etc/network/interfaces to add the required
 "dns-nameservers" lines, you should point the
 /etc/resolvconf/resolv.conf.d/tail symbolic link to /dev/null.
-------------- next part --------------
--- ../resolvconf.old/debian/templates	2008-01-18 06:22:38.669402447 +0100
+++ debian/templates	2008-01-22 18:59:23.165556615 +0100
@@ -2,55 +2,51 @@
 Type: boolean
 Default: true
 _Description: Prepare /etc/resolv.conf for dynamic updates?
- This package contains the infrastructure required for dynamic updating of
+ The resolvconf package contains the infrastructure required for dynamic updating of
  the resolver configuration file. Part of the necessary infrastructure is
  a symbolic link from /etc/resolv.conf to /etc/resolvconf/run/resolv.conf.
- If you agree then this link will be created. The existing /etc/resolv.conf
+ If you choose this option, this link will be created. The existing /etc/resolv.conf
  file will be preserved as /etc/resolvconf/resolv.conf.d/original; it will
  be restored if this package is removed.
  .
- If you wish to prevent future installations from recreating the symbolic
- link then you can run dpkg-reconfigure later to withdraw your agreement.
- .
- If you do not agree then the necessary symbolic link will not be created
- and consequently your resolver configuration file will not be dynamically
- updated. In order to activate dynamic updating you will have to configure
- resolvconf manually following the straightforward instructions in the
- README file. If you choose not to configure resolvconf at all then you
- should remove the package because its presence causes some programs to
- deviate from their default behavior.
- .
- However you decide, you should read the README file.
+ Declining this option will prevent future installations from recreating
+ the symbolic link and the resolver configuration file will not be dynamically
+ updated. Dynamic updating can then be activated from instructions in the
+ README file.
 
 Template: resolvconf/downup-interfaces
 Type: note
-_Description: Remember to reconfigure network interfaces
+_Description: Network interfaces configuration mandatory
  Once resolvconf is installed, interface configurers supply nameserver
  information to it (which it then makes available to the C Library resolver
  and to DNS caches). However, they do this only when they bring up interfaces.
  Therefore for resolvconf's nameserver information to be up to date after
- initial installation it is necessary to reconfigure interfaces --
- that is, to take them down and then to bring them up again -- and to restart
+ initial installation it is necessary to reconfigure interfaces (that is,
+ to take them down and then to bring them up again) and to restart
  DNS caches.
 
 Template: resolvconf/link-tail-to-original
 Type: boolean
 Default: false
 _Description: Append original file to dynamic file?
- If your original static resolver configuration file (/etc/resolv.conf)
- contains nameserver addresses then those addresses should be listed on
+ If the original static resolver configuration file (/etc/resolv.conf)
+ contains nameserver addresses, those addresses should be listed on
  "dns-nameservers" lines in /etc/network/interfaces as described in the
- README. Until you have modified /etc/network/interfaces and reconfigured
- the affected interfaces resolvconf will not include those addresses in the
- dynamically generated resolver configuration file. Without those addresses
- you may have trouble resolving domain names. A TEMPORARY solution is to
- append the whole original resolver configuration file to the end of
+ README file. 
+ .
+ Until you have modified /etc/network/interfaces and reconfigured
+ the affected interfaces, resolvconf will not include those addresses in the
+ dynamically generated resolver configuration file. As a temporary
+ workaround, the whole original resolver configuration file may be
+ appended to the end of
  the dynamically generated file. This will be done if there is a symbolic
  link from /etc/resolvconf/resolv.conf.d/tail to
- /etc/resolvconf/resolv.conf.d/original. If you agree then this symbolic
+ /etc/resolvconf/resolv.conf.d/original.
+ .
+ If you choose this option, this symbolic
  link will be created, provided that no /etc/resolvconf/resolv.conf.d/tail
  already exists.
  .
  After you have modified /etc/network/interfaces to add the required
- "dns-nameservers" lines you should point the
+ "dns-nameservers" lines, you should point the
  /etc/resolvconf/resolv.conf.d/tail symbolic link to /dev/null.
--- ../resolvconf.old/debian/control	2008-01-18 06:22:38.669402447 +0100
+++ debian/control	2008-01-23 07:45:06.183436083 +0100
@@ -22,5 +22,5 @@
  information are: DNS caches, resolver libraries and the
  programs that use them.
  .
- This package may require some manual configuration.  Please
+ This package may require some manual configuration. Please
  read the README file for detailed instructions.
-------------- next part --------------
Source: resolvconf
Section: net
Priority: optional
Maintainer: resolvconf maintainers <resolvconf-devel at lists.alioth.debian.org>
Uploaders: Eric Evans <eevans at sym-link.com>, Daniel Kahn Gillmor <dkg at fifthhorseman.net>, Marc Haber <mh+debian-packages at zugschlus.de>, Thomas Hood <jdthood at yahoo.co.uk>, Marco Nenciarini <mnencia at debian.org>
Build-Depends: debhelper (>= 5)
Standards-Version: 3.7.2.1

Package: resolvconf
Architecture: all
Enhances: dhcp3-client (>= 3.0+3.0.1rc11-5), dhcp-client (>= 2.0pl5-18), dhcpcd (>= 1:1.3.22pl4-9), pump (>= 0.8.19), udhcpc (>= 0.9.8cvs20050124-3), ppp (>= 2.4.2), ifupdown (>= 0.6.4-4.7), network-manager, bind9 (>= 1:9.2.3-1), bind (>= 1:8.4.1-2), dnsmasq (>= 2.9-2), pdnsd (>= 1.1.11par-1), totd (>= 1.4-4), libc6, nscd
Depends: coreutils (>= 5.93), lsb-base (>= 3.0-9), ${misc:Depends}
Conflicts: pppconfig (<< 2.3.1), pppoeconf (<< 1.0), xisp, webmin (<< 1.150-2), webmin-wvdial (<< 1.160-3), dhcp3-client (<< 3.0+3.0.1rc11-5), dhcp-client (<< 2.0pl5-18), dhcp-client (= 3.0.1betaRC4-1), dhcpcd (<< 1:1.3.22pl4-7), pump (<< 0.8.15-1), udhcpc (<< 0.9.8cvs20050124-3), pcmcia-cs (<< 3.2.5-1), ifupdown (<< 0.6.4-4.1), divine, laptop-net (<< 2.21-1), whereami (<< 0.3.3), bind9 (<< 1:9.2.1-7), bind (<< 1:8.3.4-1), dnsmasq (<< 1.13-2), pdnsd (<< 1.1.10par-4), totd (<< 1.4-4)
Description: nameserver information handler
 Resolvconf is a framework for keeping track of the system's
 information about currently available nameservers. It sets
 itself up as the intermediary between programs that supply
 nameserver information and programs that use nameserver
 information. Examples of programs that supply nameserver
 information are: ifupdown, DHCP clients, the PPP daemon and
 local nameservers. Examples of programs that use this
 information are: DNS caches, resolver libraries and the
 programs that use them.
 .
 This package may require some manual configuration. Please
 read the README file for detailed instructions.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : http://lists.alioth.debian.org/pipermail/resolvconf-devel/attachments/20080124/27022cbb/attachment.pgp 


More information about the Resolvconf-devel mailing list