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

Re: [RFR] templates://dhcp3/{dhcp3-relay.templates,dhcp3-server.templates,dhcp3-client.templates}



Christian Perrier wrote:
> Please find, for review, the debconf templates of dhcp3.

Okay.  This one's hard work...

> Template: dhcp3-relay/servers
...
> _Description: DHCP servers to which the DHCP relay should forward requests to:

Excess "to which", excess DHCP.

> Template: dhcp3-relay/interfaces
> Type: string
> _Description: Interfaces the DHCP relay should listen on:
>  Please enter the names of the network interfaces that dhcrelay should
>  attempt to configure.

The executable is dhrelay3 now, but use the packagename dhcp3-relay.
Add "...as a space-separated list" (presumably).

>  Leave this field blank, to allow for automatic detection

No comma (inserting it would make the instruction unconditional).

> and configurations of network interfaces by dhcrelay

s/ations/ation/, s/dhcrelay/dhcp3-relay/

> (non-broadcast interfaces will not be used in that case).

Less negatively, "in which case only broadcast interfaces will be
used".  We should probably retain "(if possible)".

> Template: dhcp3-relay/options
...
>  Please optionally specify additional options for the DHCP relay daemon.

Make that "Please specify any additional options..."

>  Example: "-m replace" or "-a -D".

"ExampleS:", or "For example:"

> Template: dhcp3-server/config_warn
...
>  After the DHCP server is installed, you will need to manually configure it
>  by editing the file /etc/dhcp3/dhcpd.conf. Please note that a sample
>  dhcpd.conf is supplied which is just a sample that
>  must be adapted to the network environment.

Too many samples;
                                              Please note that the dhcpd.conf
   supplied is just a sample, and must be adapted to the network environment.

On to the control files.

> Package: dhcp3-server
...
> Description: DHCP server for automatic IP address assignment
>  This is the DHCP server from version 3 of the Internet Software
>  Consortium DHCP package. For more information, visit the ISC web
>  site at http://www.isc.org.

There's quite a bit of redundancy here.  How about just:

   This is the server from version 3 of the Internet Software
   Consortium's implementation of DHCP. For more information, visit
   http://www.isc.org.

>  Dynamic Host Configuration Protocol (DHCP) is a protocol like BOOTP
>  (actually dhcpd includes much of the functionality of BOOTPD).

That's bootpd, an executable (though not one in Debian).

> It assigns IP addresses to clients based on lease times.

The addresses aren't based on the times (10.0.0.1 = mid-morning?),
and there's more to it than this; perhaps:

   It gives client machines "leases" for IP addresses and can
   automatically set their network configuration.

>  Multiple Ethernet Interfaces are supported by this DHCP package.

Unnecessary Capitalisation, and unnecessary passivisation; it isn't
a question of supported interfaces.  "This server can handle
multiple ethernet interfaces".  (But is this information useful?
What DHCP server implementation available in Debian _can't_ handle
multiple ethernet interfaces?)

> Package: dhcp3-common
...
>  This package contains all the files used by all the packages
>  from ISC DHCP version 3.

We could do without that first "all"; "contains the files"...

> Package: dhcp3-client
...
>  This is the DHCP client from version 3 of the Internet Software
>  Consortium DHCP package. For more information visit the ISC web
>  site at http://www.isc.org.

As above.

>  This is a split off from the dhcp package and contains the DHCP client
>  tools.

It has already been explained that this is the client part of ISC v3
DHCP, so this is redundant - and inaccurate, since surely it was the
ISC v2 dhcp-client that was "a split off from the dhcp package".

>  Cable modem users likely need this or another dhcp client to successfully
>  connect to the network.

Cable modem users (among others) will need an uppercase DHCP client
installed to connect (at all) to whatever particular network that
interface is on... maybe I should rewrite this from scratch.

Note that d-i installs dhcp3-client automatically, even if it didn't
find a server on the network.  This isn't a case of "if you don't
recognise the jargon, you don't need to know" - users should be told
enough about DHCP to judge whether they need to keep it installed.

As a first stab at it, I'll copy the what-DHCP-is blurb from the
dhcp3-server description and end with a modified version of the
cable-modem paragraph.

>  Documentation (apart from manpages) can be found in the dhcp package.

No, in dhcp3-common.

> Package: dhcp3-relay
...
> Description: DHCP Relay

That's lowercase "relay", and maybe add "daemon" or "server".

>  This is the DHCP relay from version 3 of the Internet Software
>  Consortium DHCP package. For more information visit the ISC web
>  site at http://www.isc.org.

As above.

>  Installing this package will make the machine it is installed on to
>  a dhcp relay. You need to have a DHCP or BOOTP server reachable in order
>  to use the relay.

s/on to/onto/ and s/dhcp relay/DHCP relay/, but this is a redundant
phrase anyway; and the "you" here is the kind that just gets in the
way.

  Installing this package will make the machine a DHCP relay, which
  requires a reachable DHCP or BOOTP server in order to function.

>  Documentation (apart from manpages) can be found in the dhcp package.

As above.
-- 
JBR
Ankh kak! (Ancient Egyptian blessing)
--- ../dhcp3.old/debian/dhcp3-client.templates	2007-05-08 00:30:03.000000000 +0100
+++ debian/dhcp3-client.templates	2007-05-08 01:23:49.000000000 +0100
@@ -1,13 +1,16 @@
+# Should probably be dropped
 Template: dhcp3-client/dhclient-script_moved
 Type: note
-_Description: dhclient-script has moved!
- As of 3.0.4-2, dhclient-script is installed in /sbin and is no longer a
- conffile. /etc/dhcp3/dhclient-script appears to have been modified at some
- point, so it has not been removed, however it is no longer being used.
+_Description: dhclient-script moved
+ As of 3.0.4-2, dhclient-script is installed in /sbin and is no longer
+ registered as a configuration file. /etc/dhcp3/dhclient-script
+ appears to have been modified at some point, so it has not been
+ removed. However it is no longer being used.
  .
- Please consider using the hook infrastructure (see dhclient-script(8) for more
- information) instead of modifying dhclient-script.
+ Please consider using the hook infrastructure (see dhclient-script(8)
+ for more information) instead of modifying dhclient-script.
 
+# Should probably be dropped
 Template: dhcp3-client/dhclient-needs-restarting
 Type: note
 _Description: dhclient needs restarting
--- ../dhcp3.old/debian/dhcp3-relay.templates	2007-05-08 00:30:03.000000000 +0100
+++ debian/dhcp3-relay.templates	2007-05-08 02:10:52.000000000 +0100
@@ -1,24 +1,25 @@
 Template: dhcp3-relay/servers
 Type: string
-_Description: DHCP servers to which the DHCP relay should forward requests to:
- The name or IP address of at least one DHCP server to which DHCP and BOOTP
- requests should be relayed must be specified on the command line.
+_Description: Servers the DHCP relay should forward requests to:
+ Please enter the hostname or IP address of at least one DHCP server
+ to which DHCP and BOOTP requests should be relayed.
  .
- You can specify more than one server, just separate the server names (or
- IP addresses) with spaces.
+ You can specify more than one server; server names or
+ IP addresses should then be space-separated.
 
 Template: dhcp3-relay/interfaces
 Type: string
 _Description: Interfaces the DHCP relay should listen on:
- The names of the network interfaces that dhcrelay should attempt to
- configure may be specified on the command line using the -i option. If no
- interface names are specified on the command line dhcrelay will identify
- all network interfaces, elimininating non-broadcast interfaces if
- possible, and attempt to configure each interface.
+ Please enter the names of the network interfaces that dhcp3-relay
+ should attempt to configure, as a space-separated list.
+ .
+ Leave this field blank to allow for automatic detection and
+ configuration of network interfaces by dhcp3-relay, in which case
+ only broadcast interfaces will be used (if possible).
 
 Template: dhcp3-relay/options
 Type: string
-_Description: Additional options for the Daemon:
- It is possible to specify additional options for the DHCP relay daemon.
+_Description: Additional options for the DHCP relay daemon:
+ Please specify any additional options for the DHCP relay daemon.
  .
- example: "-m replace" or "-a -D"
+ For example: "-m replace" or "-a -D".
--- ../dhcp3.old/debian/dhcp3-server.templates	2007-05-08 00:30:03.000000000 +0100
+++ debian/dhcp3-server.templates	2007-05-08 02:12:46.000000000 +0100
@@ -1,33 +1,35 @@
 Template: dhcp3-server/config_warn
 Type: note
-_Description: Manual configuration required after installation!
- After the DHCP server is installed you will need to manually configure it
- by editing the file /etc/dhcp3/dhcpd.conf. Please note that a sample
- dhcpd.conf is supplied, but the configuration there is just a sample that
- requires editing and customization to your own network environment.
+_Description: Manual configuration required after installation
+ After the DHCP server is installed, you will need to manually configure it
+ by editing the file /etc/dhcp3/dhcpd.conf. Please note that the dhcpd.conf
+ supplied is just a sample, and must be adapted to the network environment.
  .
  Please configure the DHCP server as soon as the installation finishes.
 
 Template: dhcp3-server/interfaces
 Type: string
 _Description: Network interfaces on which the DHCP server should listen:
- You can enter one or more valid interface names, like eth0. If you want to
- serve DHCP request on more than one interface, please separate them with
- spaces. If you want dhcpd to figure out the interface leave this parameter
+ Please enter a space-separated list of interfaces names (e.g. eth0) 
+ on which the server should answer DHCP requests.
+ .
+ The interfaces will be automatically detected if this field is left
  blank.
 
+# Should probably be dropped
 Template: dhcp3-server/new_auth_behavior
 Type: note
 _Description: Non-authoritative version of DHCP server
- The version 3 DHCP server is now non-authoritative by default.
+ The version 3 DHCP server is non-authoritative by default.
  .
  This means that if a client requests an address that the server knows
  nothing about and the address is incorrect for that network segment, the
  server will _not_ send a DHCPNAK (which tells the client it should stop
- using the address.) If you want to change this behavior, you must
+ using the address). If you want to change this behavior, you must
  explicitly state in dhcpd.conf what network segments your server is
  authoritative for using the 'authoritative' statement.
 
+# Should probably be dropped
 Template: dhcp3-server/new_next-server_behaviour
 Type: note
 _Description: Change in default behaviour of the next-server directive
--- ../dhcp3.old/debian/control	2007-05-08 00:30:03.000000000 +0100
+++ debian/control	2007-05-08 02:02:03.000000000 +0100
@@ -12,25 +12,24 @@
 Depends: debianutils (>= 2.8.2), dhcp3-common (= ${Source-Version}), ${shlibs:Depends}, ${misc:Depends}
 Conflicts: dhcp
 Description: DHCP server for automatic IP address assignment
- This is the DHCP server from version 3 of the Internet Software
- Consortium DHCP package. For more information visit the ISC web
- site at http://www.isc.org.
+ This is the server from version 3 of the Internet Software
+ Consortium's implementation of DHCP. For more information, visit
+ http://www.isc.org.
  .
  Dynamic Host Configuration Protocol (DHCP) is a protocol like BOOTP
- (actually dhcpd includes much of the functionality of BOOTPD!). It assigns
- IP addresses to clients based on lease times. DHCP is used extensively
- by Microsoft and more recently also by Apple. It is probably essential
- in any multi-platform environment.
+ (actually dhcpd includes much of the functionality of bootpd). It
+ gives client machines "leases" for IP addresses and can
+ automatically set their network configuration.
  .
- Multiple Ethernet Interfaces are supported by this DHCP package.
+ This server can handle multiple ethernet interfaces.
 
 Package: dhcp3-common
 Architecture: any
 Section: net
 Depends: debianutils (>= 2.8.2), ${shlibs:Depends}, ${misc:Depends}
-Description: Common files used by all the dhcp3* packages
- This package contains all the files used by all the packages
- from ISC DHCP version 3.
+Description: common files used by all the dhcp3* packages
+ This package contains the files used by all the packages from ISC
+ DHCP version 3.
 
 Package: dhcp3-dev
 Priority: optional
@@ -38,7 +37,7 @@
 Section: devel
 Depends: libc6-dev
 Description: API for accessing and modifying the DHCP server and client state
- OMAPI, an API for accessing and modifying the DHCP server and
+ OMAPI is an API for accessing and modifying the DHCP server and
  client state.
 
 Package: dhcp3-client
@@ -46,18 +45,20 @@
 Depends: debianutils (>= 2.8.2), dhcp3-common (= ${Source-Version}), ${shlibs:Depends}, ${misc:Depends}
 Suggests: resolvconf, avahi-autoipd
 Conflicts: dhcp-client (<< 3.0), samba-common (<< 3.0.0beta1-2)
-Description: DHCP Client
- This is the DHCP client from version 3 of the Internet Software
- Consortium DHCP package. For more information visit the ISC web
- site at http://www.isc.org.
+Description: DHCP client
+ This is the client from version 3 of the Internet Software
+ Consortium's implementation of DHCP. For more information visit
+ http://www.isc.org.
  .
- This is a split off from the dhcp package and contains the DHCP client
- tools.
- .
- Cable modem users likely need this or another dhcp client to successfully
- connect to the network.
+ Dynamic Host Configuration Protocol (DHCP) is a protocol like BOOTP
+ (actually dhcpd includes much of the functionality of bootpd). It
+ gives client machines "leases" for IP addresses and can
+ automatically set their network configuration. If your machine
+ depends on DHCP (especially likely if it's a workstation on a large
+ network, or a laptop, or attached to a cable modem), keep this or
+ another DHCP client installed.
  .
- Documentation (apart from manpages) can be found in the dhcp package.
+ Extra documentation can be found in the package dhcp3-common.
 
 Package: dhcp3-client-udeb
 Priority: extra
@@ -74,13 +75,12 @@
 Architecture: any
 Depends: debianutils (>= 2.8.2), dhcp3-common (= ${Source-Version}), ${shlibs:Depends}, ${misc:Depends}
 Conflicts: dhcp-relay
-Description: DHCP Relay
- This is the DHCP relay from version 3 of the Internet Software
- Consortium DHCP package. For more information visit the ISC web
- site at http://www.isc.org.
- .
- Installing this package will make the machine it is installed on to
- a dhcp relay. You need to have a DHCP or BOOTP server reachable in order
- to use the relay.
+Description: DHCP relay daemon
+ This is the relay from version 3 of the Internet Software
+ Consortium's implementation of DHCP. For more information visit
+ http://www.isc.org.
+ .
+ Installing this package will make the machine a DHCP relay, which
+ requires a reachable DHCP or BOOTP server in order to function.
  .
- Documentation (apart from manpages) can be found in the dhcp package.
+ Extra documentation can be found in the package dhcp3-common.
# Should probably be dropped
Template: dhcp3-client/dhclient-script_moved
Type: note
_Description: dhclient-script moved
 As of 3.0.4-2, dhclient-script is installed in /sbin and is no longer
 registered as a configuration file. /etc/dhcp3/dhclient-script
 appears to have been modified at some point, so it has not been
 removed. However it is no longer being used.
 .
 Please consider using the hook infrastructure (see dhclient-script(8)
 for more information) instead of modifying dhclient-script.

# Should probably be dropped
Template: dhcp3-client/dhclient-needs-restarting
Type: note
_Description: dhclient needs restarting
 As always, dhclient is not restarted on upgrade, so you are still running the
 previous version of dhclient. You can restart it by doing an ifdown and ifup
 on the interface(s) that are configured to use DHCP, or by explicitly killing
 and restarting dhclient.
 .
 Naturally, you should exercise caution if you are managing a remote server via
 an interface using DHCP.
Template: dhcp3-relay/servers
Type: string
_Description: Servers the DHCP relay should forward requests to:
 Please enter the hostname or IP address of at least one DHCP server
 to which DHCP and BOOTP requests should be relayed.
 .
 You can specify more than one server; server names or
 IP addresses should then be space-separated.

Template: dhcp3-relay/interfaces
Type: string
_Description: Interfaces the DHCP relay should listen on:
 Please enter the names of the network interfaces that dhcp3-relay
 should attempt to configure, as a space-separated list.
 .
 Leave this field blank to allow for automatic detection and
 configuration of network interfaces by dhcp3-relay, in which case
 only broadcast interfaces will be used (if possible).

Template: dhcp3-relay/options
Type: string
_Description: Additional options for the DHCP relay daemon:
 Please specify any additional options for the DHCP relay daemon.
 .
 For example: "-m replace" or "-a -D".
Template: dhcp3-server/config_warn
Type: note
_Description: Manual configuration required after installation
 After the DHCP server is installed, you will need to manually configure it
 by editing the file /etc/dhcp3/dhcpd.conf. Please note that the dhcpd.conf
 supplied is just a sample, and must be adapted to the network environment.
 .
 Please configure the DHCP server as soon as the installation finishes.

Template: dhcp3-server/interfaces
Type: string
_Description: Network interfaces on which the DHCP server should listen:
 Please enter a space-separated list of interfaces names (e.g. eth0) 
 on which the server should answer DHCP requests.
 .
 The interfaces will be automatically detected if this field is left
 blank.

# Should probably be dropped
Template: dhcp3-server/new_auth_behavior
Type: note
_Description: Non-authoritative version of DHCP server
 The version 3 DHCP server is non-authoritative by default.
 .
 This means that if a client requests an address that the server knows
 nothing about and the address is incorrect for that network segment, the
 server will _not_ send a DHCPNAK (which tells the client it should stop
 using the address). If you want to change this behavior, you must
 explicitly state in dhcpd.conf what network segments your server is
 authoritative for using the 'authoritative' statement.

# Should probably be dropped
Template: dhcp3-server/new_next-server_behaviour
Type: note
_Description: Change in default behaviour of the next-server directive
 From version 3.0.3, the DHCP server's default value of the
 next-server directive has changed. If you are network booting clients, and
 your TFTP server is your DHCP server, you need to explicitly set a
 next-server directive to state this. Please see
 /usr/share/doc/dhcp3-server/NEWS.Debian.gz and
 /usr/share/doc/dhcp3-common/RELNOTES.gz for more information.
Source: dhcp3
Section: net
Priority: important
Maintainer: Eloy A. Paris <peloy@debian.org>
Uploaders: Matt Zimmerman <mdz@debian.org>, Andrew Pollock <apollock@debian.org>
Build-Depends: debhelper (>= 4.1.16), dpkg-dev (>= 1.13.2), groff, dpatch, po-debconf
Standards-Version: 3.5.6

Package: dhcp3-server
Priority: optional
Architecture: any
Depends: debianutils (>= 2.8.2), dhcp3-common (= ${Source-Version}), ${shlibs:Depends}, ${misc:Depends}
Conflicts: dhcp
Description: DHCP server for automatic IP address assignment
 This is the server from version 3 of the Internet Software
 Consortium's implementation of DHCP. For more information, visit
 http://www.isc.org.
 .
 Dynamic Host Configuration Protocol (DHCP) is a protocol like BOOTP
 (actually dhcpd includes much of the functionality of bootpd). It
 gives client machines "leases" for IP addresses and can
 automatically set their network configuration.
 .
 This server can handle multiple ethernet interfaces.

Package: dhcp3-common
Architecture: any
Section: net
Depends: debianutils (>= 2.8.2), ${shlibs:Depends}, ${misc:Depends}
Description: common files used by all the dhcp3* packages
 This package contains the files used by all the packages from ISC
 DHCP version 3.

Package: dhcp3-dev
Priority: optional
Architecture: any
Section: devel
Depends: libc6-dev
Description: API for accessing and modifying the DHCP server and client state
 OMAPI is an API for accessing and modifying the DHCP server and
 client state.

Package: dhcp3-client
Architecture: any
Depends: debianutils (>= 2.8.2), dhcp3-common (= ${Source-Version}), ${shlibs:Depends}, ${misc:Depends}
Suggests: resolvconf, avahi-autoipd
Conflicts: dhcp-client (<< 3.0), samba-common (<< 3.0.0beta1-2)
Description: DHCP client
 This is the client from version 3 of the Internet Software
 Consortium's implementation of DHCP. For more information visit
 http://www.isc.org.
 .
 Dynamic Host Configuration Protocol (DHCP) is a protocol like BOOTP
 (actually dhcpd includes much of the functionality of bootpd). It
 gives client machines "leases" for IP addresses and can
 automatically set their network configuration. If your machine
 depends on DHCP (especially likely if it's a workstation on a large
 network, or a laptop, or attached to a cable modem), keep this or
 another DHCP client installed.
 .
 Extra documentation can be found in the package dhcp3-common.

Package: dhcp3-client-udeb
Priority: extra
Architecture: any
Section: debian-installer
Depends: ${shlibs:Depends}
Conflicts: dhcp-client-udeb
XC-Package-Type: udeb
Description: DHCP Client for debian-installer
 dhcp-client-udeb is a minimal dhcp package used by the debian-installer.

Package: dhcp3-relay
Priority: optional
Architecture: any
Depends: debianutils (>= 2.8.2), dhcp3-common (= ${Source-Version}), ${shlibs:Depends}, ${misc:Depends}
Conflicts: dhcp-relay
Description: DHCP relay daemon
 This is the relay from version 3 of the Internet Software
 Consortium's implementation of DHCP. For more information visit
 http://www.isc.org.
 .
 Installing this package will make the machine a DHCP relay, which
 requires a reachable DHCP or BOOTP server in order to function.
 .
 Extra documentation can be found in the package dhcp3-common.

Reply to: