From joel@automatvapen.se  Wed Dec 29 23:16:41 2004
Return-Path: <joel@automatvapen.se>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id E490916A4CE
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 29 Dec 2004 23:16:40 +0000 (GMT)
Received: from av6-2-sn3.vrr.skanova.net (av6-2-sn3.vrr.skanova.net [81.228.9.180])
	by mx1.FreeBSD.org (Postfix) with ESMTP id EFD7043D4C
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 29 Dec 2004 23:16:39 +0000 (GMT)
	(envelope-from joel@automatvapen.se)
Received: by av6-2-sn3.vrr.skanova.net (Postfix, from userid 502)
	id C504037F61; Thu, 30 Dec 2004 00:16:37 +0100 (CET)
Received: from smtp3-1-sn3.vrr.skanova.net (smtp3-1-sn3.vrr.skanova.net [81.228.9.101])
	by av6-2-sn3.vrr.skanova.net (Postfix) with ESMTP id B534037E5B
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 30 Dec 2004 00:16:37 +0100 (CET)
Received: from dude.automatvapen.se (t4o55p9.telia.com [62.20.171.129])
	by smtp3-1-sn3.vrr.skanova.net (Postfix) with SMTP id 8B7D437E44
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 30 Dec 2004 00:16:36 +0100 (CET)
Received: by dude.automatvapen.se (sSMTP sendmail emulation); Thu, 30 Dec 2004 00:16:57 +0100
Message-Id: <20041229231636.8B7D437E44@smtp3-1-sn3.vrr.skanova.net>
Date: Thu, 30 Dec 2004 00:16:57 +0100
From: "Joel Dahl" <joel@automatvapen.se>
Reply-To: Joel Dahl <joel@automatvapen.se>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [patch] Handbook, chapter 11.8, LINT does not exist on 5.x by default
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         75639
>Category:       docs
>Synopsis:       [patch] Handbook, chapter 11.8, LINT does not exist on 5.x by default
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    den
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Dec 29 23:20:25 GMT 2004
>Closed-Date:    Fri Jan 14 08:01:59 GMT 2005
>Last-Modified:  Fri Jan 14 08:01:59 GMT 2005
>Originator:     Joel Dahl
>Release:        FreeBSD 5.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD dude.automatvapen.se 5.3-STABLE FreeBSD 5.3-STABLE #1: Sat Nov 13 19:50:36 CET 2004 joel@dude.automatvapen.se:/usr/obj/usr/src/sys/WRK i386

	
>Description:
LINT does not exist on 5.x by default (yes, I know, you can still
build it), so pointing users to this file is wrong.
/usr/src/sys/conf/NOTES and /usr/src/sys/i386/conf/NOTES contains
information about various network interfaces, so a more correct
approach would be to point users to these files instead.

Suggested patch attached.
	
>How-To-Repeat:
	
>Fix:
	

--- lintnotes.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
retrieving revision 1.191
diff -u -r1.191 chapter.sgml
--- chapter.sgml	29 Nov 2004 21:43:36 -0000	1.191
+++ chapter.sgml	29 Dec 2004 22:56:27 -0000
@@ -863,8 +863,9 @@
 	if your card is supported.</para>
 
       <para>Once you are sure your card is supported, you need
-	to determine the proper driver for the card.  The file
-	<filename>/usr/src/sys/i386/conf/LINT</filename> will give you
+	to determine the proper driver for the card.
+	<filename>/usr/src/sys/conf/NOTES</filename> and
+	<filename>/usr/src/sys/i386/conf/NOTES</filename> will give you
 	the list of network interfaces drivers with some information
 	about the supported chipsets/cards.  If you have doubts about
 	which driver is the correct one, read the manual page of the
@@ -872,6 +873,15 @@
 	the supported hardware and even the possible problems that
 	could occur.</para>
 
+      <note>
+        <para><filename>NOTES</filename> does not exist on
+          &os;&nbsp;4.X.  Instead, check the <filename>LINT</filename>
+          file for information about various network interfaces.  See
+          <xref linkend="kernelconfig-config"> for a more detailed
+          summary of <filename>NOTES</filename> versus
+          <filename>LINT</filename>.</para>
+      </note>
+
       <para>If you own a common card, most of the time you will not
 	have to look very hard for a driver.  Drivers for common
 	network cards are present in the <filename>GENERIC</filename>
@@ -900,7 +910,8 @@
 	network card drivers (ISA cards and cards using the &man.ed.4;
 	driver, for example).  Alternatively, you may statically compile
 	the support for your card into your kernel.  Check
-	<filename>/usr/src/sys/i386/conf/LINT</filename> and the
+	<filename>/usr/src/sys/conf/NOTES</filename>,
+	<filename>/usr/src/sys/i386/conf/NOTES</filename>, and the
 	manual page of the driver to know what to add in your kernel
 	configuration file.  For more information about recompiling your
 	kernel, please see <xref linkend="kernelconfig">.  If your card
--- lintnotes.diff ends here ---


>Release-Note:
>Audit-Trail:

From: Ceri Davies <ceri@submonkey.net>
To: Joel Dahl <joel@automatvapen.se>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/75639: [patch] Handbook, chapter 11.8, LINT does not exist on 5.x by default
Date: Wed, 29 Dec 2004 23:42:38 +0000

 On Thu, Dec 30, 2004 at 12:16:57AM +0100, Joel Dahl wrote:
 
 Hi Joel,
 
 While you're changing this area, could you also add this fix to the
 patch please?  Thanks.
 
 > RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
 > retrieving revision 1.191
 > diff -u -r1.191 chapter.sgml
 > --- chapter.sgml	29 Nov 2004 21:43:36 -0000	1.191
 > +++ chapter.sgml	29 Dec 2004 22:56:27 -0000
 > @@ -863,8 +863,9 @@
 >  	if your card is supported.</para>
 >  
 >        <para>Once you are sure your card is supported, you need
 > -	to determine the proper driver for the card.  The file
 > -	<filename>/usr/src/sys/i386/conf/LINT</filename> will give you
 > +	to determine the proper driver for the card.
 > +	<filename>/usr/src/sys/conf/NOTES</filename> and
 > +	<filename>/usr/src/sys/i386/conf/NOTES</filename> will give you
 >  	the list of network interfaces drivers with some information
 	                            ^^^
 s/faces/face/
 
 Ceri
 -- 
 Only two things are infinite, the universe and human stupidity, and I'm
 not sure about the former.			  -- Einstein (attrib.)

From: Joel Dahl <joel@automatvapen.se>
To: Ceri Davies <ceri@submonkey.net>
Cc: FreeBSD-gnats-submit@FreeBSD.org
Subject: Re: docs/75639: [patch] Handbook, chapter 11.8, LINT does not
	exist on 5.x by default
Date: Thu, 30 Dec 2004 00:58:20 +0100

 --=-aOF/jPssBiMupQtR8mJq
 Content-Type: text/plain
 Content-Transfer-Encoding: 7bit
 
 On Wed, 2004-12-29 at 23:42 +0000, Ceri Davies wrote:
 > On Thu, Dec 30, 2004 at 12:16:57AM +0100, Joel Dahl wrote:
 > 
 > Hi Joel,
 > 
 > While you're changing this area, could you also add this fix to the
 > patch please?  Thanks.
 > 
 > > RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
 > > retrieving revision 1.191
 > > diff -u -r1.191 chapter.sgml
 > > --- chapter.sgml	29 Nov 2004 21:43:36 -0000	1.191
 > > +++ chapter.sgml	29 Dec 2004 22:56:27 -0000
 > > @@ -863,8 +863,9 @@
 > >  	if your card is supported.</para>
 > >  
 > >        <para>Once you are sure your card is supported, you need
 > > -	to determine the proper driver for the card.  The file
 > > -	<filename>/usr/src/sys/i386/conf/LINT</filename> will give you
 > > +	to determine the proper driver for the card.
 > > +	<filename>/usr/src/sys/conf/NOTES</filename> and
 > > +	<filename>/usr/src/sys/i386/conf/NOTES</filename> will give you
 > >  	the list of network interfaces drivers with some information
 > 	                            ^^^
 > s/faces/face/
 
 Sure, new patch attached.
 
 --
 Joel
 
 --=-aOF/jPssBiMupQtR8mJq
 Content-Disposition: attachment; filename=lintnotes2.diff
 Content-Type: text/x-patch; name=lintnotes2.diff; charset=us-ascii
 Content-Transfer-Encoding: 7bit
 
 Index: chapter.sgml
 ===================================================================
 RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
 retrieving revision 1.191
 diff -u -r1.191 chapter.sgml
 --- chapter.sgml	29 Nov 2004 21:43:36 -0000	1.191
 +++ chapter.sgml	29 Dec 2004 23:50:27 -0000
 @@ -863,15 +863,25 @@
  	if your card is supported.</para>
  
        <para>Once you are sure your card is supported, you need
 -	to determine the proper driver for the card.  The file
 -	<filename>/usr/src/sys/i386/conf/LINT</filename> will give you
 -	the list of network interfaces drivers with some information
 +	to determine the proper driver for the card.
 +	<filename>/usr/src/sys/conf/NOTES</filename> and
 +	<filename>/usr/src/sys/i386/conf/NOTES</filename> will give you
 +	the list of network interface drivers with some information
  	about the supported chipsets/cards.  If you have doubts about
  	which driver is the correct one, read the manual page of the
  	driver.  The manual page will give you more information about
  	the supported hardware and even the possible problems that
  	could occur.</para>
  
 +      <note>
 +        <para><filename>NOTES</filename> does not exist on
 +          &os;&nbsp;4.X.  Instead, check the <filename>LINT</filename>
 +          file for information about various network interfaces.  See
 +          <xref linkend="kernelconfig-config"> for a more detailed
 +          summary of <filename>NOTES</filename> versus
 +          <filename>LINT</filename>.</para>
 +      </note>
 +
        <para>If you own a common card, most of the time you will not
  	have to look very hard for a driver.  Drivers for common
  	network cards are present in the <filename>GENERIC</filename>
 @@ -900,7 +910,8 @@
  	network card drivers (ISA cards and cards using the &man.ed.4;
  	driver, for example).  Alternatively, you may statically compile
  	the support for your card into your kernel.  Check
 -	<filename>/usr/src/sys/i386/conf/LINT</filename> and the
 +	<filename>/usr/src/sys/conf/NOTES</filename>,
 +	<filename>/usr/src/sys/i386/conf/NOTES</filename>, and the
  	manual page of the driver to know what to add in your kernel
  	configuration file.  For more information about recompiling your
  	kernel, please see <xref linkend="kernelconfig">.  If your card
 
 --=-aOF/jPssBiMupQtR8mJq--
 
Responsible-Changed-From-To: freebsd-doc->den 
Responsible-Changed-By: den 
Responsible-Changed-When: Fri Jan 14 07:26:39 GMT 2005 
Responsible-Changed-Why:  
I will take this one 

http://www.freebsd.org/cgi/query-pr.cgi?pr=75639 
State-Changed-From-To: open->closed 
State-Changed-By: den 
State-Changed-When: Fri Jan 14 08:00:52 GMT 2005 
State-Changed-Why:  
Committed, thanks! 

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