docs/51109: [PATCH] handbook (kernelconfig)

[Martin Karlsson]

>Number:         51109
>Category:       docs
>Synopsis:       [PATCH] handbook (kernelconfig)
>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:   Thu Apr 17 15:20:12 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator:     Martin Karlsson
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD c-49c170d5 5.0-CURRENT FreeBSD 5.0-CURRENT #0: Thu Apr 17 07:40:57 CEST 2003 root at c-49c170d5:/usr/obj/usr/src/sys/K20030417 i386


>Description:
The handbook does explain how to copy GENERIC to MYKERNEL, and edit
MYKERNEL, but does not explicitly mention why editing
GENERIC directly is a bad idea.  Perhaps it should? This patch aims to
fix that.

I have seen related questions (Where did GENERIC go?) on -questions only
a few times, but being explicit about important things is rarely bad IMO.

>How-To-Repeat:
Read the handbook, 9.3 Building and Installing a Custom Kernel.
>Fix:

	

--- kernelconfig.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
retrieving revision 1.104
diff -u -r1.104 chapter.sgml
--- chapter.sgml	2003/03/31 17:01:34	1.104
+++ chapter.sgml	2003/04/17 21:55:17
@@ -186,6 +186,13 @@
       call it <filename>MYKERNEL</filename> for the purpose of this
       example.</para>
 
+    <note>
+      <para>Do <emphasis>not</emphasis> simply edit <filename>GENERIC</filename>.
+	If you do, it will be overwritten the next time you <link
+	linkend="cutting-edge">update your source tree</link>, and all
+	your kernel modifications will be lost.</para>
+    </note>
+
     <tip>
       <para>Storing your kernel config file directly under
 	<filename>/usr/src</filename> can be a bad idea.  If you are
--- kernelconfig.diff ends here ---


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