Removed links disclaimer; no longer needs to be mentioned because it was years ago.
[ikiwiki.git] / docs / user / DebugKernelCrashDumps.mdwn
index 2e8ffa6..caf0149 100644 (file)
@@ -20,9 +20,9 @@ To circumvent this problem you can change the default settings in `/etc/rc.conf`
 
 
 
-[[!table  data="""
-| `dumpdev` | Indicates the device (usually a swap partition) to which a crash dump should be written in the event of a system crash. 
- `dumpdir` | savecore(8) will save that crash dump and a copy of the kernel to the directory specified by the dumpdir variable.  The default value is /var/crash.  You can set this to another directory on another partition with more space available to safely obtain the dump. |
+[[!table header=no  data="""
+> `dumpdev` | | Indicates the device (usually a swap partition) to which a crash dump should be written in the event of a system crash. 
+> `dumpdir` | | savecore(8) will save that crash dump and a copy of the kernel to the directory specified by the dumpdir variable.  The default value is /var/crash.  You can set this to another directory on another partition with more space available to safely obtain the dump. 
 """]]
 
 If you are unsure about your swap partition device, use [swapinfo(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#swapinfo&section8) or look into `/etc/fstab` :
@@ -37,9 +37,9 @@ If you are unsure about your swap partition device, use [swapinfo(8)](http://lea
     /dev/ad0s1b             none            swap    sw              0       0
 
 
-### Enable debugging options in your kernel config 
+### Enable debugging options in your custom kernel config 
 
-If you don't know how to configure a custom kernel, look into [Configuring the DragonFly Kernel](kernelconfig.html).  You have to add the following lines to compile your kernel with debugging symbols:
+If you run a custom kernel you have to add the following lines to compile your kernel with debugging symbols:
 
     
 
@@ -56,6 +56,7 @@ If you want additional support for the interactive kernel debugger [ddb(4)](http
     options         INVARIANTS
 
 
+You don't have to do anything to get debugging enabled in the default GENERIC kernel as it's already there.
 
 ## How does a crash look like? 
 
@@ -93,7 +94,6 @@ Before your machine reboots a crash dump is saved into your swap partition (if y
 
 Now your machine reboots, checks its file system and finally extracts the crash dump from the swap partition to your `dumpdir` (see `rc.conf` setting above).  If your `/var` partition is to small, you'll see an error similar to the following:
 
-    
 
     savecore: reboot after panic: from debugger
     savecore: no dump, not enough free space on device (231420 available, need 541840)
@@ -114,19 +114,21 @@ You can use [savecore(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#savec
 
 
 
-This will take some time dependent on the speed of your machine.  See the man page of savecore(8) for more available options.
+This will take some time dependent on the speed of your machine.  See the man page of `savecore(8)` for more available options.
+
 
 ### Upload the crash dump 
 
-If you don't have the ability or skills to debug are crash yourselves, please upload the complete content of your crash directory to a public available location (HTTP, FTP web space or your leaf account) and send a detailed bug report to the bugs@dragonflybsd.org list.  If its possible please tar and compress (gzip, bzip2) the directory to save disk space and bandwith.
+If you don't have the ability or skills to debug the crash yourselves, please upload the complete content of your crash directory to somewhere private (e.g., cloud share with a password, your leaf account), and open a detailed bug report.  Please tar and compress the crash dump to save disk space and bandwidth.
 
+**WARNING**: The saved core file (in `/var/crash`) contains *sensitive* data, e.g., passwords, certificates, decrypted private keys.  Therefore, do *not* upload it to somewhere that can be publicly accessed!
 
 
 ## Debug the crash dump with kgdb 
 
 The [kgdb(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#kgdb&section1) utility is a debugger based on gdb(1) that allows debugging of kernel core files.
 
-### kgdb extesions 
+### kgdb extensions 
 
 To get some handy helper command execute the following command before starting kgdb: