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

Thomas Hood jdthood at gmail.com
Thu Jan 24 18:48:19 UTC 2008


First of all, thanks for taking time to review the templates.

I give my opinions below, but I will accept whatever consensus
emerges.


Christian Perrier wrote:
> 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


OK


>   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"...:)


Agreed, except that I prefer 'if ... then ...' to 'if ... , ...'.


>   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.


The sentence "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." should be there, perhaps
de-personalized, if this is a goal.

s/link and the resolver/link and therefore the resolver/


>  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..:-))


The reason for the verbosity is that resolvconf's maintainer scripts
can't correctly configure the system if the admin has done unusual
kinds of customization.  The consequences of failure are relatively
grave (broken name resolution), so warnings seem justified.


>   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


OK


>  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...


OK


>   "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.


If the text is to be de-personalized, then:

   s/you should point the ... symbolic link/the ... symbolic link should be pointed/


> --- ../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.


OK

-- 
Thomas



More information about the Resolvconf-devel mailing list