Bug 181331

Summary: Typo (missing letter) in example dhcpd config for netboot.
Product: Documentation Reporter: Keve Nagy <keve>
Component: Books & ArticlesAssignee: Warren Block <wblock>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Keve Nagy 2013-08-15 20:10:00 UTC 
There is a typo in the example configuration code for dhcpd in the netboot section of the handbook.
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/network-pxe-nfs.html
Section 31.8.3. Setting up the DHCP Server, step 2, sample config line #6.
  option domain-name-server 192.168.35.35, 192.168.35.36 ;
A letter "s" is missing from the end of the second word, making domain-name-server in singular instead of plural. The correct line should read
  option domain-name-servers 192.168.35.35, 192.168.35.36 ;

I was trying to do some testing today, following the handbook step by step. ISC DHCPD refuses to start with the incorrectly spelt keyword in it. It does not recognize "domain-name-server", it only recognizes the plural form as "domain-name-servers".
As the incorrect form is actually a proper English expression and the line without the pluralizing "s" makes perfect sense (especially when one has a single nameserver to define), it is easy to make the mistake. For the same reason, it could be very difficult for an inexperienced sysadmin or a beginner FreeBSD user to spot the problem.
This should be corrected as soon as anyone with access right to the documentation source can afford the time and energy to commit the correction.

Fix: 

Replace the line
  option domain-name-server 192.168.35.35, 192.168.35.36 ;
with
  option domain-name-servers 192.168.35.35, 192.168.35.36 ;
adding a pluralizing "s" to the end of keyword domain-name-serverS.
How-To-Repeat: Follow chapter 31.8.3 of the handbook to the letter and make the spelling mistake shown in the example configuration code.
Comment 1 Warren Block freebsd_committer freebsd_triage 2013-08-15 21:39:50 UTC 
Responsible Changed
From-To: freebsd-doc->wblock

Take.
Comment 2 dfilter service freebsd_committer freebsd_triage 2013-08-15 21:46:00 UTC 
Author: wblock
Date: Thu Aug 15 20:45:50 2013
New Revision: 42550
URL: http://svnweb.freebsd.org/changeset/doc/42550

Log:
  Correct "domain-name-server" to the plural form.
  
  PR:		docs/181331
  Submitted by:	Keve Nagy <keve@safe-mail.net>

Modified:
  head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml	Thu Aug 15 02:39:21 2013	(r42549)
+++ head/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.xml	Thu Aug 15 20:45:50 2013	(r42550)
@@ -4468,7 +4468,7 @@ myhost.example.com:/b/tftpboot/FreeBSD/i
    option subnet-mask 255.255.255.0 ;
    option routers 192.168.0.1 ;
    option broadcast-address 192.168.0.255 ;
-   option domain-name-server 192.168.35.35, 192.168.35.36 ;
+   option domain-name-servers 192.168.35.35, 192.168.35.36 ;
    option domain-name "example.com";
 
    # IP address of TFTP server
_______________________________________________
svn-doc-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"
Comment 3 Warren Block freebsd_committer freebsd_triage 2013-08-15 21:46:03 UTC 
State Changed
From-To: open->closed

Change committed, thanks!