[WebKit-https.git] / Websites / webkit.org / building / debug.html
1 <?php
2     $title = "Debugging WebKit";
3     include("../header.inc");
4 ?>
6 <div class="mac-instructions">
7 <h2>Debugging on Mac OS X</h2>
8 <p>Each WebKit component -- JavaScriptCore, WebCore, and WebKit2 -- contains its own Xcode project that depends on the build location specified in the project itself. In Xcode 4, choose Xcode > Preferences > Locations, click Locations, click the Advanced button, and ensure that the build location is Locations Specified by Targets.</p>
9 <h3>Debugging UIProcess</h3>
10 <p>Follow the instructions on the <a href="debug-mac-uiprocess.html">debugging UIProcess</a> page.</p>
11 <h3>Debugging WebProcess</h3>
12 <ol>
13 <li><p>Launch Safari</p>
14 <p>Follow the instructions on <a href="run.html">Running WebKit</a> to launch Safari from the command line with the WebKit version you built. Alternatively you can <a href="debug-mac-uiprocess.html">use the WebKit2 Xcode project to launch Safari</a>.</p>
15 </li>
16 <li><p>Open a project</p>
17 <p>Open the Xcode project belonging to the component -- WebCore or JavaScriptCore -- you want to debug.</p>
18 </li>
19 <li><p>Attach to WebProcess</p>
20 <p>Choose Product > Attach to Process > WebProcess.</p>
21 </li>
22 <li><p>See the <a href="http://developer.apple.com/library/mac/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/Debugging/Debugging.html#//apple_ref/doc/uid/TP40010215-CH3-SW1">Xcode Debugging Guide</a> for more information on using Xcode to debug software on Mac OS X.</p>
23 </li>
24 </ol>
25 </div>
26 <div class="windows-instructions">
27 <h2>Debugging on Windows</h2>
28 <ol>
29 <li><p>Open <code>WebKit/WebKit/win/WebKit.vcproj/WebKit.sln</code></p>
30 <p>You can open it in either Visual Studio 2005, or Visual C++ Express 2005.
31 If you get errors about not being able to find <code>.vsprops</code> files, run
32 update-webkit, then close and relaunch Cygwin and Visual Studio or Visual C++
33 Express.</p>
34 </li>
35 <li><p>Set WebKit.vcproj as the solution's StartUp project</p>
36 <p>Select the WebKit project in the Solution Explorer, then choose Project >
37 Set as StartUp Project. This will cause the project to turn bold in the
38 Solution Explorer.</p>
39 <img src="set-as-startup-project-vs2005.png">
40 </li>
41 <li><p>Set WebKit.vcproj's Debugging properties</p>
42 <p>With the WebKit project selected, choose Project > Properties, then navigate
43 to Configuration Properties > Debugging. Set the following options:</p>
44 <dl>
45     <dt>Command</dt>
46     <dd><code>$(PROGRAMFILES)\Safari\Safari.exe</code></dd>
47     <dt>Environment</dt>
48     <dd><code>WEBKITNIGHTLY=$(OutDir)</code></dd>
49 </dl>
50 <p>Then click <code>OK</code> to close the properties dialog.</p>
51 <img src="set-debugging-properties-vs2005.png">
52 </li>
53 <li><p>Launch the debugger</p>
54 <p>Choose Debug > Start Debugging.</p>
55 <img src="launch-debugger-vs2005.png">
56 </ol>
57 <p>It is also recommended that you follow <a href="http://developer.apple.com/internet/safari/windows_symbols_agree.html">the instructions to configure Visual Studio to use Apple's Safari for Windows symbol server</a>. This will give Visual Studio the information it needs to provide reliable backtraces when pausing in the debugger or when a crash occurs.</p>
58 </div>
60 <?php
61     include("../footer.inc");
62 ?>