docs/75639: [patch] Handbook, chapter 11.8, LINT does not exist on 5.x by default

[Joel Dahl]

>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:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Dec 29 23:20:25 GMT 2004
>Closed-Date:
>Last-Modified:
>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 at 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; 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:
>Unformatted: