From keramida@ceid.upatras.gr  Wed Jun 20 11:07:48 2001
Return-Path: <keramida@ceid.upatras.gr>
Received: from mailsrv.otenet.gr (mailsrv.otenet.gr [195.170.0.5])
	by hub.freebsd.org (Postfix) with ESMTP id B311A37B401
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 20 Jun 2001 11:07:47 -0700 (PDT)
	(envelope-from keramida@ceid.upatras.gr)
Received: from hades.hell.gr (patr530-b104.otenet.gr [195.167.121.232])
	by mailsrv.otenet.gr (8.11.1/8.11.1) with ESMTP id f5KI7hS00890
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 20 Jun 2001 21:07:44 +0300 (EEST)
Received: (from charon@localhost)
	by hades.hell.gr (8.11.4/8.11.3) id f5KHhlU01195;
	Wed, 20 Jun 2001 20:43:47 +0300 (EEST)
	(envelope-from charon)
Message-Id: <200106201743.f5KHhlU01195@hades.hell.gr>
Date: Wed, 20 Jun 2001 20:43:47 +0300 (EEST)
From: Giorgos Keramidas <keramida@ceid.upatras.gr>
Reply-To: Giorgos Keramidas <keramida@ceid.upatras.gr>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: change request for sys/i386/conf/NOTES
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         28296
>Category:       kern
>Synopsis:       change request for sys/i386/conf/NOTES
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    dd
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Wed Jun 20 11:10:03 PDT 2001
>Closed-Date:    Wed Jul 18 23:04:30 PDT 2001
>Last-Modified:  Wed Jul 18 23:04:38 PDT 2001
>Originator:     Giorgos Keramidas
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:

System: FreeBSD hades.hell.gr 5.0-CURRENT FreeBSD 5.0-CURRENT #0: Wed Jun 20 12:35:01 EEST 2001 root@hades.hell.gr:/usr/obj/usr/src/sys/GENERIC i386

>Description:

The NOTES file revision 1.926 contains the following (slightly edited
to avoid wrapping beyond column 80):

    options  CONSPEED=9600  #default speed for serial console (default 9600)

>How-To-Repeat:

$ grep CONSPEED /usr/src/sys/i386/conf/NOTES

>Fix:

I think that using the word `default' twice in the same line is a bit
too much.  Perhaps it would be better if this comment was:

    # speed for serial console (default 9600)

>Release-Note:
>Audit-Trail:

From: Dima Dorfman <dima@unixfreak.org>
To: Giorgos Keramidas <keramida@ceid.upatras.gr>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: kern/28296: change request for sys/i386/conf/NOTES 
Date: Wed, 20 Jun 2001 14:56:53 -0700

 Giorgos Keramidas <keramida@ceid.upatras.gr> writes:
 > 
 > >Number:         28296
 > >Category:       kern
 > >Synopsis:       change request for sys/i386/conf/NOTES
 > >Description:
 > 
 > The NOTES file revision 1.926 contains the following (slightly edited
 > to avoid wrapping beyond column 80):
 > 
 >     options  CONSPEED=9600  #default speed for serial console (default 9600)
 > 
 > >Fix:
 > 
 > I think that using the word `default' twice in the same line is a bit
 > too much.  [...]
 
 I think what it's trying to say is that CONSPEED is the default
 console speed, and 9600 is the default value of the default.  I.e.,
 the speed of a specific console can be changed at run-time *and* the
 initial speed of a new console can be changed at run time.  This
 compile-time variable sets the initial value of the latter variable.
 
 					Dima Dorfman
 					dima@unixfreak.org

From: Bruce Evans <bde@zeta.org.au>
To: Dima Dorfman <dima@unixfreak.org>
Cc: freebsd-gnats-submit@FreeBSD.ORG
Subject: Re: kern/28296: change request for sys/i386/conf/NOTES 
Date: Thu, 21 Jun 2001 14:55:59 +1000 (EST)

 On Wed, 20 Jun 2001, Dima Dorfman wrote:
 
 >  Giorgos Keramidas <keramida@ceid.upatras.gr> writes:
 >  > 
 >  > >Number:         28296
 >  > >Category:       kern
 >  > >Synopsis:       change request for sys/i386/conf/NOTES
 >  > >Description:
 >  > 
 >  > The NOTES file revision 1.926 contains the following (slightly edited
 >  > to avoid wrapping beyond column 80):
 >  > 
 >  >     options  CONSPEED=9600  #default speed for serial console (default 9600)
 >  > 
 >  > >Fix:
 >  > 
 >  > I think that using the word `default' twice in the same line is a bit
 >  > too much.  [...]
 >  
 >  I think what it's trying to say is that CONSPEED is the default
 >  console speed, and 9600 is the default value of the default.  I.e.,
 >  the speed of a specific console can be changed at run-time *and* the
 >  initial speed of a new console can be changed at run time.  This
 >  compile-time variable sets the initial value of the latter variable.
 
 Anyway, it is a bug NOTES to set options to their default value.  The
 default values get linted enough by GENERIC, so NOTES should lint
 non-default values.  This line should say:
 
 options 	CONSPEED=115200		#speed for serial console (default 9600)
 
 modulo style bugs and usage bugs.
 
 Style bugs:
 - Missing space after '#'.  NOTES is very inconsistent, but mostly uses a
   space after the comment character except for commenting out options.
 - Comment not in English (missing capitalization and punctuation).  NOTES is
   very inconsistent...
 - Line too long (80 columns).
 - NOTES is not a good place to decument defaults, except negatively by
   setting non-defaults.
 
 Usage bugs:
 - This option should never be used, at least on i386's.  It was superseded
   by better support for using the speed set by the boot loader (this
   speed is configured by BOOT_COMCONSOLE_SPEED in /etc/make.conf).  It
   was removed in 1997 in rev.1.170 of sio.c but unremoved in the next
   commit, apparently to work around deficiencies in nonstandard boot
   loaders.  There is also a sysctl to change the speed.
 
 Bruce
 
State-Changed-From-To: open->analyzed 
State-Changed-By: dd 
State-Changed-When: Thu Jun 21 12:50:13 PDT 2001 
State-Changed-Why:  
Line and comment fixed as discussed, thanks! 


Responsible-Changed-From-To: freebsd-bugs->dd 
Responsible-Changed-By: dd 
Responsible-Changed-When: Thu Jun 21 12:50:13 PDT 2001 
Responsible-Changed-Why:  
My MFC reminder. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=28296 
State-Changed-From-To: analyzed->closed 
State-Changed-By: dd 
State-Changed-When: Wed Jul 18 23:04:30 PDT 2001 
State-Changed-Why:  
MFC'd, thanks. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=28296 
>Unformatted:
