Add debugger related functions to the InspectorController and
[WebKit-https.git] / WebKitSite / building / build.html
1 <?php
2     $title = "Building WebKit";
3     include("../header.inc");
4 ?>
5
6 <h2>Building WebKit</h2>
7
8 Building WebKit requires that you have the proper <a href="tools.html">developer tools
9 installed</a> and that you have a copy of the <a href="checkout.html">WebKit source tree</a>.
10
11 <div class="windows-instructions">
12 <h4>Windows</h4>
13 <ol>
14 <li><p>Open a Cygwin Shell (if not already open from checking out sources)</p>
15 <p>Double-click the Cygwin icon on your Desktop to launch a new shell.
16 </ol>
17 </div>
18
19 <ol>
20 <li><p>Type this command to build WebKit:</p>
21 <p class="code">WebKit/WebKitTools/Scripts/build-webkit</p>
22 <p>Use the <tt>--debug</tt> option for a debug build, which includes debugging symbols and assertions:</p>
23 <p class="code">WebKit/WebKitTools/Scripts/build-webkit --debug</p>
24 </li>
25 </ol>
26
27 <p>By default, <tt>build-webkit</tt> places build products in <tt>WebKit/WebKitBuild</tt>.  You can specify a different build
28 location on Mac in your Xcode preferences.  On Windows, the <tt>WEBKITOUTPUTDIR</tt> environment variable can be used to
29 set a different build products location.  If you have set up a custom build location, then <tt>build-webkit</tt> will
30 place the build products there.</p>
31
32 <div class="windows-instructions">
33 <h4>Windows</h4>
34 <p>A common source of build errors on Windows is Visual C++ Express forgetting the Platform SDK paths.  If you have trouble building WebKit,
35 double check that the paths you set during <a href="http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/">step 3 of the Platform SDK Installation</a>
36 are still there and add them again if necessary.</p>
37 <p>Don't forget that if you have any questions or problems building WebKit, feel free to <a href="/contact.html">get in touch!</a></p>
38 </div>
39
40 <h2>Setting a Default Configuration</h2>
41 <ol>
42 <li><p>To set a default build configuration for <tt>build-webkit</tt> and other scripts, use the <tt>set-webkit-configuration</tt> script:</p>
43 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --debug</p>
44 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --release</p>
45 </li>
46 </ol>
47
48 <hr>
49 <p>It's handy to put <tt>WebKit/WebKitTools/Scripts</tt> in your shell path so you can type commands like <tt>build-webkit</tt> without specifying a full path.</p>
50
51 <p>Once your build has finished, you can <A href="run.html">run it inside Safari.</a></p>
52
53 <?php
54     include("../footer.inc");
55 ?>