From dodell@raqdevil.offmyserver.com  Mon Jul 25 20:57:54 2005
Return-Path: <dodell@raqdevil.offmyserver.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 8D98016A420
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 25 Jul 2005 20:57:54 +0000 (GMT)
	(envelope-from dodell@raqdevil.offmyserver.com)
Received: from raqdevil.offmyserver.com (ext-unused-110.ixsystems.net [206.40.55.110])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 118BD43D55
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 25 Jul 2005 20:57:53 +0000 (GMT)
	(envelope-from dodell@raqdevil.offmyserver.com)
Received: from raqdevil.offmyserver.com (smmsp@localhost [127.0.0.1])
	by raqdevil.offmyserver.com (8.13.1/8.13.1) with ESMTP id j6PKvOxn083628
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 25 Jul 2005 13:57:24 -0700 (PDT)
	(envelope-from dodell@raqdevil.offmyserver.com)
Received: (from root@localhost)
	by raqdevil.offmyserver.com (8.13.1/8.13.1/Submit) id j6PKvO3I083627;
	Mon, 25 Jul 2005 13:57:24 -0700 (PDT)
	(envelope-from dodell)
Message-Id: <200507252057.j6PKvO3I083627@raqdevil.offmyserver.com>
Date: Mon, 25 Jul 2005 13:57:24 -0700 (PDT)
From: "Devon H. O'Dell" <dodell@offmyserver.com>
Reply-To: "Devon H. O'Dell" <dodell@offmyserver.com>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [PATCH] Serial Communication Doc Error 
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         84094
>Category:       docs
>Synopsis:       [PATCH] Serial Communication Doc Error
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Jul 25 21:00:30 GMT 2005
>Closed-Date:    Tue Jul 26 09:30:23 GMT 2005
>Last-Modified:  Tue Jul 26 09:30:23 GMT 2005
>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"' &gt; /boot/loader.conf</screen>
+	  <screen>&prompt.root; echo 'set console="comconsole"' &gt; /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"' &gt; /boot/loader.conf</screen>
+	  <screen>&prompt.root; echo 'console="comconsole"' &gt; /boot/loader.conf</screen>
 	</step>
 
 	<step>
--- serial.diff ends here ---


>Release-Note:
>Audit-Trail:

From: John Baldwin <jhb@FreeBSD.org>
To: freebsd-doc@freebsd.org,
 "Devon H. O'Dell" <dodell@offmyserver.com>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/84094: [PATCH] Serial Communication Doc Error
Date: Mon, 25 Jul 2005 17:37:46 -0400

 On Monday 25 July 2005 04:57 pm, Devon H. O'Dell wrote:
 > >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.
 
 Agreed.  This sort of thing belongs in loader.conf.
 
 -- 
 John Baldwin <jhb@FreeBSD.org>  <><  http://www.FreeBSD.org/~jhb/
 "Power Users Use the Power to Serve"  =  http://www.FreeBSD.org
State-Changed-From-To: open->closed 
State-Changed-By: blackend 
State-Changed-When: Tue Jul 26 09:29:51 GMT 2005 
State-Changed-Why:  
Fixed using loader.conf solution. 
Thanks. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=84094 
>Unformatted:
