From 3a73fcfff7bd9308507f532e6055bec232780dc9 Mon Sep 17 00:00:00 2001
From: sommerfeld <sommerfeld@NetBSD.org>
Date: Sat, 20 Nov 1999 19:57:01 +0000
Subject: [PATCH] Include clues on what to do with the crash dump once you've
 got it

---
 sbin/savecore/savecore.8 | 50 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 2 deletions(-)

diff --git a/sbin/savecore/savecore.8 b/sbin/savecore/savecore.8
index d228c5188eb2..6cc28b748e49 100644
--- a/sbin/savecore/savecore.8
+++ b/sbin/savecore/savecore.8
@@ -1,4 +1,4 @@
-.\"	$NetBSD: savecore.8,v 1.14 1999/09/17 10:20:01 is Exp $
+.\"	$NetBSD: savecore.8,v 1.15 1999/11/20 19:57:01 sommerfeld Exp $
 .\"
 .\" Copyright (c) 1980, 1991, 1993
 .\"	The Regents of the University of California.  All rights reserved.
@@ -47,12 +47,48 @@
 .Op Fl N Ar system
 .Ar directory
 .Sh DESCRIPTION
+When the
+.Nx 
+kernel encounters a fatal error, the 
+.Xr panic 9
+routine arranges for a snapshot of the contents of physical memory to
+be written into a dump area, typically in the swap partition.  
+.Pp
+Upon a subsequent reboot,
 .Nm
-copies the currently running kernel and its associated core dump into
+is typically run out of 
+.Xr rc 8 ,
+before swapping is enabled, to copy the kernel and the saved memory image
+into
 .Fa directory ,
 and enters a reboot message and information about the core dump into
 the system log.
 .Pp
+The kernel and core file can then be analyzed using various tools,
+including
+.Xr dmesg 8 ,
+.Xr fstat 1 ,
+.Xr gdb 1 ,
+.Xr iostat 8 ,
+.Xr netstat 1 ,
+.Xr ps 1 ,
+and
+.Xr pstat 8 ,
+to attempt to deduce the cause of the crash.
+.Pp
+Crashes are usually the result of kernel bugs; if this is suspected, a
+full bug report should be filed using
+.Xr send-pr 8 ,
+containing as much information as possible about the circumstances of
+the crash.  Since crash dumps are typically very large and may contain
+whatever (potentially confidential) information was in memory at the
+time of the crash, do
+.Em NOT
+include a copy of the crash dump file in the bug report; instead, save it
+somewhere in the event that a 
+.Nx 
+developer wants to examine it.
+.Pp
 The options are as follows:
 .Bl -tag -width directory
 .It Fl c
@@ -124,6 +160,16 @@ current kernel
 The minfree code does not consider the effect of compression.
 .Sh SEE ALSO
 .Xr compress 1 ,
+.Xr dmesg 8 ,
+.Xr fstat 1 ,
+.Xr gdb 1 ,
+.Xr iostat 8 ,
+.Xr netstat 1 ,
+.Xr ps 1 , 
+.Xr pstat 8 , 
+.Xr panic 9 ,
+.Xr rc 8 ,
+.Xr send-pr 1 ,
 .Xr syslogd 8
 .Sh HISTORY
 The