68a240cc55d91105493830cda5486f761c875253
[WebKit.git] / WebKitSite / quality / crashlogs.html
1 <?php
2     $title = "Getting a Useful Crash Log";
3     include("../header.inc");
4 ?>
5 <h2>Getting a Useful Crash Log</h2>
6 <p>Crash logs are incredibly useful when trying to track down a bug, especially if it's not immediately reproducible.</p>
7
8 <div class="mac-instructions" id="mac">
9     <h4>Mac OS X</h4>
10     <p>Obtaining a crash log on Mac OS X is incredibly easy since it automatically creates easily accessible crash logs for you.</p>
11     <ol>
12         <li>
13             <p>If WebKit has just crashed or you can easily reproduce the crash, press the Report button on the CrashReporter dialog box
14             to view the crash information.</p>
15             <img src="mac_reportbox.jpg" alt="Mac OS X Crash report box">
16         </li>
17         <li>
18             <p>Copy and paste the entire contents of the top portion of the CrashReporter window into your favorite text editor and
19             upload it as an attachment in Bugzilla.</p>
20             <img src="mac_viewtrace.jpg" alt="Mac OS X Crash log">
21         </li>
22         <li>
23             <p>If the crash report dialog does not appear or the crash is hard to reproduce, crash logs can be retrieved from the <tt>~/Library/Logs/CrashReporter</tt> folder.</p>
24             <p>On Leopard (Mac OS X 10.5), crash logs are stored as individually dated and time stamped files. Despite having a &ldquo;.crash&rdquo;
25                 extension, they are plain text files and can be attached directly to a bug report.</p>
26             <p>On Tiger (Mac OS X 10.4), all crashes are logged to <tt>Safari.crash.log</tt>. This is a plain text file and can
27                 be viewed in the default Console.app or your favorite text editor. <strong>All</strong> of Safari's crashes are logged
28                 to this file so please only attach the last crash in it. Crashes are separated by a series of asterisks
29                 (&lowast;&lowast;&lowast;&lowast;&lowast;&lowast;&lowast;&lowast;&lowast;&lowast;) for easy identification.</p>
30         </li>
31     </ol>
32 </div>
33
34 <div class="windows-instructions" id="win">
35     <h4>Windows XP</h4>
36     <p>Windows XP does not automatically log crashes like OS X, but it does include Dr. Watson, an easy to set up tool that can be
37         configured to log them.</p>
38     <ol>
39         <li>
40             <p>In the Start menu's Run box or from a DOS or Cygwin prompt, enter the command <tt>drwtsn32 -i</tt>.</p>
41             <img src="win_installwatson.jpg" alt="Dr Watson install command">
42         </li>
43         <li>
44             <p>A dialog box will appear informing you that Dr. Watson has been installed as the default debugger. Press OK.</p>
45             <img src="win_watsoninstalled.jpg" alt="Dr Watson was installed box">
46         </li>
47         <li>
48             <p>Crash information will now be logged to the <tt>user.dmp</tt> file in
49             <tt>C:\Documents and Settings\All Users\Application Data\Microsoft\Dr Watson\</tt>.</p>
50
51             <p>Dr. Watson will create a <tt>user.dmp</tt> file that records what WebKit was doing when it crashed.
52                 Be careful as it is overwritten with every crash.</p>
53
54             <p>When reporting a WebKit bug, please upload the <tt>user.dmp</tt> file if possible.</p>
55         </li>
56         <li>
57             <p>Running <tt>drwtsn32</tt> without any options or switches will bring up a window that allows you to change various
58                 setting such as moving the log folder to a more easily accessible location or throwing a visual alert letting
59                 you know it caught the crash.</p>
60             <img src="win_watsongui.jpg" alt="Dr Watson window">
61         </li>
62     </ol>
63     <h4>Windows Vista</h4>
64     <p>Windows Vista does not include Dr. Watson. Instead, Windows Error Reporting (WER) has been integrated into the operating system.
65        By default, Vista uploads the crash logs to Microsoft, but does not save a local copy. This is configurable via the registry.</p>
66     <ol>
67         <li>
68             <p>Save the following text to a file named <tt>wer.reg</tt>:</p><tt style="white-space:pre">Windows Registry Editor Version 5.00
69
70 [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting]
71 "ForceQueue"=dword:00000001
72 </tt>
73         </li>
74         <li><p>Double-click the file from Windows Explorer and respond affirmatively to any prompts.</p></li>
75         <li><p>Reboot</p></li>        
76     </ol>
77     <p>
78         The next time Safari (or any other application) crashes, the crash information will be written into a folder located inside <tt>%LOCALAPPDATA%\Microsoft\Windows\WER\ReportQueue</tt>.
79         Check the modification date to make sure you are using the correct file.
80     </p>
81     <p>Be sure to include the following files in your bug report:</p>
82     <dl style="margin-left:2em">
83         <dt><tt>WER<em>xxxx</em>.tmp.mdmp</tt></dt>
84         <dd>This is the most important file. It contains the crash dump that can be opened inside Visual Studio or other Windows debuggers.</dd>
85         <dt><tt>WER<em>xxxx</em>.tmp.version.txt</tt></dt>
86         <dd>Contains the operating system version and other hardware information.</dd>
87         <dt><tt>WER<em>xxxx</em>.tmp.appcompat.txt</tt></dt>
88         <dd>Lists all of the DLLs loaded at the time of the crash with their version information.</dd>
89     </dl>
90 </div>
91
92 <?php
93     include("../footer.inc");
94 ?>