From martink@shell.linux.se  Thu Apr 17 15:18:57 2003
Return-Path: <martink@shell.linux.se>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 3B8EC37B407
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 17 Apr 2003 15:18:57 -0700 (PDT)
Received: from mf1.bredband.net (mf1.bredband.net [195.54.106.36])
	by mx1.FreeBSD.org (Postfix) with ESMTP id A604F43FBD
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 17 Apr 2003 15:18:53 -0700 (PDT)
	(envelope-from martink@shell.linux.se)
Received: from localhost.036-23-6f72652.cust.bredbandsbolaget.se
          ([213.112.193.73]) by mf1.bredband.net with ESMTP
          id <20030417221852.CEXZ269.mf1@localhost.036-23-6f72652.cust.bredbandsbolaget.se>
          for <FreeBSD-gnats-submit@freebsd.org>;
          Fri, 18 Apr 2003 00:18:52 +0200
Received: from c-49c170d5.036-23-6f72652.cust.bredbandsbolaget.se (localhost [127.0.0.1])
	by localhost.036-23-6f72652.cust.bredbandsbolaget.se (8.12.9/8.12.9) with ESMTP id h3HMH3xJ094290
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 18 Apr 2003 00:18:25 +0200 (CEST)
	(envelope-from martink@c-49c170d5.036-23-6f72652.cust.bredbandsbolaget.se)
Received: (from martink@localhost)
	by c-49c170d5.036-23-6f72652.cust.bredbandsbolaget.se (8.12.9/8.12.9/Submit) id h3HMGV35094287;
	Fri, 18 Apr 2003 00:16:31 +0200 (CEST)
	(envelope-from martink)
Message-Id: <200304172216.h3HMGV35094287@c-49c170d5.036-23-6f72652.cust.bredbandsbolaget.se>
Date: Fri, 18 Apr 2003 00:16:31 +0200 (CEST)
From: Martin Karlsson <mk-freebsd@bredband.net>
Reply-To: Martin Karlsson <mk-freebsd@bredband.net>
To: FreeBSD-gnats-submit@freebsd.org, freebsd-doc@FreeBSD.ORG
Cc:
Subject: [PATCH] handbook (kernelconfig)
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         51109
>Category:       docs
>Synopsis:       [PATCH] handbook (kernelconfig)
>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:   Thu Apr 17 15:20:12 PDT 2003
>Closed-Date:    Fri Apr 18 07:53:36 PDT 2003
>Last-Modified:  Fri Apr 18 07:53:36 PDT 2003
>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@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:

From: Martin Heinen <martin@sumuk.de>
To: Martin Karlsson <mk-freebsd@bredband.net>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/51109: [PATCH] handbook (kernelconfig)
Date: Fri, 18 Apr 2003 01:08:57 +0200

 On Fri, Apr 18, 2003 at 12:16:31AM +0200, Martin Karlsson wrote:
 
 > >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 ---
 
 The tip continues, but the diff doesn't :-)
 
 
 |      <para>Storing your kernel config file directly under
 |	<filename>/usr/src</filename> can be a bad idea.  If you are
 |	experiencing problems it can be tempting to just delete
 |	<filename>/usr/src</filename> and start again.  Five seconds after
 |	you do that you realize that you have deleted your custom kernel
 |	config file.</para>
 
 Do we need to clarify this?  If so, this should be
 added to the tip.
 
 -- 
 Marxpitn

From: Martin Karlsson <mk-freebsd@bredband.net>
To: Martin Heinen <martin@sumuk.de>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/51109: [PATCH] handbook (kernelconfig)
Date: Fri, 18 Apr 2003 02:37:27 +0200

 --u3/rZRmxL6MmkK24
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 
 Hi,
 
 * Martin Heinen <martin@sumuk.de> [2003-04-18 01.08 +0200]:
 [...snip...]
 > The tip continues, but the diff doesn't :-)
 
 :-)  I see what you mean.
 
 > 
 > |      <para>Storing your kernel config file directly under
 > |	<filename>/usr/src</filename> can be a bad idea.  If you are
 > |	experiencing problems it can be tempting to just delete
 > |	<filename>/usr/src</filename> and start again.  Five seconds after
 > |	you do that you realize that you have deleted your custom kernel
 > |	config file.</para>
 > 
 > Do we need to clarify this?  If so, this should be
 > added to the tip.
 
 Perhaps we don't. I'll attach a re-worked diff, but feel free to 
 close the PR if you think it would be too explicit.
 
 > -- 
 > Marxpitn
 
 -- 
 Martin Karlsson
 
 --u3/rZRmxL6MmkK24
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: attachment; filename="kernelconfig2.diff"
 
 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/18 00:26:51
 @@ -192,7 +192,10 @@
  	experiencing problems it can be tempting to just delete
  	<filename>/usr/src</filename> and start again.  Five seconds after
  	you do that you realize that you have deleted your custom kernel
 -	config file.</para>
 +	config file.  Do not edit <filename>GENERIC</filename>
 +	directly, as it may get overwritten the next time you
 +	<link linkend="cutting-edge">update your source tree</link>, and
 +	your kernel modifications will be lost.</para>
  
        <para>You might want to keep your kernel config file elsewhere, and then
  	create a symbolic link to the file in the <filename>i386</filename>
 
 --u3/rZRmxL6MmkK24--

From: Martin Heinen <martin@sumuk.de>
To: Martin Karlsson <mk-freebsd@bredband.net>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/51109: [PATCH] handbook (kernelconfig)
Date: Fri, 18 Apr 2003 14:44:12 +0200

 On Fri, Apr 18, 2003 at 02:37:27AM +0200, Martin Karlsson wrote:
 > * Martin Heinen <martin@sumuk.de> [2003-04-18 01.08 +0200]:
 
 > > Do we need to clarify this?  If so, this should be
 > > added to the tip.
 > 
 > Perhaps we don't. I'll attach a re-worked diff, but feel free to 
 > close the PR if you think it would be too explicit.
 
 Good catch, we can't be clear enough.  I'll commit it shortly.
 
 -- 
 Marxpitn
State-Changed-From-To: open->closed 
State-Changed-By: mheinen 
State-Changed-When: Fri Apr 18 07:46:04 PDT 2003 
State-Changed-Why:  
Applied the second patch.  Thanks for your submission. 

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