From chris@holly.dyndns.org Sat May 22 17:54:29 1999
Return-Path: <chris@holly.dyndns.org>
Received: from leap.innerx.net (leap.innerx.net [38.179.176.25])
	by hub.freebsd.org (Postfix) with ESMTP id B420E15101
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 22 May 1999 17:54:28 -0700 (PDT)
	(envelope-from chris@holly.dyndns.org)
Received: from holly.dyndns.org (ip216.houston13.tx.pub-ip.psi.net [38.27.213.216])
	by leap.innerx.net (Postfix) with ESMTP id 96F82370BF
	for <FreeBSD-gnats-submit@freebsd.org>; Sat, 22 May 1999 20:54:26 -0400 (EDT)
Received: (from chris@localhost)
	by holly.dyndns.org (8.9.3/8.9.3) id TAA09872;
	Sat, 22 May 1999 19:56:13 -0500 (CDT)
	(envelope-from chris)
Message-Id: <199905230056.TAA09872@holly.dyndns.org>
Date: Sat, 22 May 1999 19:56:13 -0500 (CDT)
From: chris@calldei.com
Sender: chris@holly.dyndns.org
Reply-To: chris@calldei.com
To: FreeBSD-gnats-submit@freebsd.org
Subject: [Patch] doc/en/handbook/kerneldebug/chapter.sgml is out of date
X-Send-Pr-Version: 3.2

>Number:         11849
>Category:       docs
>Synopsis:       [Patch] doc/en/handbook/kerneldebug/chapter.sgml is out of date
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    nik
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat May 22 18:00:01 PDT 1999
>Closed-Date:    Sat May 29 05:55:33 PDT 1999
>Last-Modified:  Sat May 29 05:56:04 PDT 1999
>Originator:     Chris Costello
>Release:        FreeBSD 4.0-CURRENT i386
>Organization:
None.
>Environment:

doc tree, CVSupped a couple days ago.

>Description:

kerneldebug/chapter.sgml refers to out of date information, such as
how to build a debug kernel.  Also, it has a typo and a contraction that
could be avoided.

These synopsis lines are a bit redundant, eh?

>How-To-Repeat:

See http://www.freebsd.org/handbook/x19251.html

>Fix:

Index: chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en/handbook/kerneldebug/chapter.sgml,v
retrieving revision 1.13
diff -u -r1.13 chapter.sgml
--- chapter.sgml	1999/04/12 04:41:20	1.13
+++ chapter.sgml	1999/05/23 00:50:55
@@ -242,7 +242,7 @@
     <screen>&prompt.root; <userinput>ddd -k /var/crash/kernel.0 /var/crash/vmcore.0</userinput></screen>
     
     <para>You should then be able to go about looking at the crash dump using
-      <command>ddd</command>'d graphical interface.</para>
+      <command>ddd</command>'s graphical interface.</para>
   </sect1>
   
   <sect1>
@@ -254,15 +254,17 @@
 	
     <para>Of course, you still need to enable crash dumps.  See above on the
       options you have to specify in order to do this.</para>
-	
-    <para>Go to your kernel compile directory, and edit the line containing
-      <literal>COPTFLAGS?=-O</literal>.  Add the <option>-g</option> option
-      there (but <emphasis>do not</emphasis> change anything on the level of
-      optimization).  If you do already know roughly the probable location of
-      the failing piece of code (e.g., the <devicename>pcvt</devicename>
-      driver in the example above), remove all the object files for this code.
-      Rebuild the kernel.  Due to the time stamp change on the Makefile, there
-      will be some other object files rebuild, for example
+    <para>
+      Go to your kernel config directory
+      (<filename>/usr/src/sys/<replaceable>arch</replaceable>/conf</filename>)
+      and edit your configuration file.  Uncomment (or add, if it does not
+      exist) the following line</para>
+<programlisting>
+makeoptions    DEBUG=-g                #Build kernel with gdb(1) debug symbols
+</programlisting>
+    <para>
+      Rebuild the kernel.  Due to the time stamp change on the Makefile,
+      there will be some other object files rebuild, for example
       <filename>trap.o</filename>.  With a bit of luck, the added
       <option>-g</option> option will not change anything for the generated
       code, so you will finally get a new kernel with similar code to the
@@ -481,7 +483,7 @@
   <sect1>
     <title>On-line Kernel Debugging Using Remote GDB</title>
     
-    <para>This feature has been supported since FreeBSD 2.2, and it's actually
+    <para>This feature has been supported since FreeBSD 2.2, and it is actually
       a very neat one.</para>
     
     <para>GDB has already supported <emphasis>remote debugging</emphasis> for

>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->nik 
Responsible-Changed-By: nik 
Responsible-Changed-When: Fri May 28 16:47:12 PDT 1999 
Responsible-Changed-Why:  
Got it. 
State-Changed-From-To: open->closed 
State-Changed-By: nik 
State-Changed-When: Sat May 29 05:55:33 PDT 1999 
State-Changed-Why:  
Committed, thanks. 
>Unformatted:
