Reviewed by Alexey.
[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 <p>Building WebKit requires a <a href="checkout.html">WebKit source tree</a> and <a href="http://developer.apple.com/tools/xcode/">Xcode</a> version 2.3 or greater.<p>
9
10 <ol>
11 <li><p>Type this command to build WebKit:</p>
12 <p class="code">WebKit/WebKitTools/Scripts/build-webkit</p>
13 <p>Use the <tt>--debug</tt> option for a debug build, which includes debugging symbols and assertions:</p>
14 <p class="code">WebKit/WebKitTools/Scripts/build-webkit --debug</p>
15 </li>
16 </ol>
17
18 <p>By default, <tt>build-webkit</tt> places build products in WebKit/WebKitBuild. If your Xcode preferences specify a custom build products location, <tt>build-webkit</tt> places build products there.</p>
19 <p>More information about building WebKit is available on the <a href="http://trac.webkit.org/projects/webkit/wiki">WebKit Wiki</a>.</p>
20
21 <h2>Setting a Default Configuration</h2>
22 <ol>
23 <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>
24 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --debug</p>
25 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --release</p>
26 </li>
27 </ol>
28
29 <hr>
30 <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>
31
32 <?php
33     include("../footer.inc");
34 ?>