docs/84094: [PATCH] Serial Communication Doc Error

[Devon H. O'Dell]

>Number:         84094
>Category:       docs
>Synopsis:       [PATCH] Serial Communication Doc Error
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Jul 25 21:00:30 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator:     Devon H. O'Dell
>Release:        N/A
>Organization:
OffMyServer, Inc.
>Environment:
N/A

>Description:
	The serial communications chapter of the handbook implies that setting up boot
	messages to be output on the serial console can be quickly achieved by inserting

	set console="comconsole"

	into /boot/loader.conf

	This is incorrect and will trigger a syntax error. Instead, the same line should
	be inserted into /boot/loader.rc _or_ the ``set'' part should be removed to give
	the equivilant for loader.conf(5)

	The attached patches contain a choice of corrections; I suppose it is up to the
	doc team to decide which is more applicable. I would personally prefer the
	loader.conf(5) one (the second patch) since changing loader.rc generally seems
	to me to be a bad idea.

>How-To-Repeat:
	N/A

>Fix:
--- serial.diff begins here ---
--- en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml.old	Mon Jul 25 13:47:11 2005
+++ en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml.2	Mon Jul 25 13:47:32 2005
@@ -1948,7 +1948,7 @@
 	<step>
 	  <para>To see all boot messages on the serial console, issue
 	    the following command while logged in as the superuser:</para>
-	  <screen>&prompt.root; echo 'set console="comconsole"' > /boot/loader.conf</screen>
+	  <screen>&prompt.root; echo 'set console="comconsole"' > /boot/loader.rc</screen>
 	</step>
 
 	<step>
--- en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml.old	Mon Jul 25 13:47:11 2005
+++ en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml	Mon Jul 25 13:47:47 2005
@@ -1948,7 +1948,7 @@
 	<step>
 	  <para>To see all boot messages on the serial console, issue
 	    the following command while logged in as the superuser:</para>
-	  <screen>&prompt.root; echo 'set console="comconsole"' > /boot/loader.conf</screen>
+	  <screen>&prompt.root; echo 'console="comconsole"' > /boot/loader.conf</screen>
 	</step>
 
 	<step>
--- serial.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: