72ff72463d7dce9f0804f76d8a116674116835a5
[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>Before you build WebKit, you'll need to <a href="checkout.html">check out</a> sources. Next make sure that you have Xcode, preferably
9 the latest version, which is 2.2.1 at this point. You will need at least Xcode 2.1 to be able to build WebKit.<p>
10
11 <ol>
12
13 <li><p>To start a build, use the <tt>build-webkit</tt> script.</p>
14 <p class="code">WebKitTools/Scripts/build-webkit</p>
15 <p>It's handy to put the <tt>WebKitTools/Scripts</tt> directory in your shell path so you can type commands like <tt>build-webkit</tt> without specifying the path to the script.</p>
16 </li>
17
18 <li><p>Once the frameworks are built, you'll probably want to run Safari using the newly-built WebKit. To do that, use the <tt>run-safari</tt> script.</p>
19 <p class="code">WebKitTools/Scripts/run-safari</p>
20 <p>This script sets up the <tt>DYLD_FRAMEWORK_PATH</tt> environment variable, which will cause the system loader to use the
21 frameworks you built from your Xcode build products directory instead of the ones installed in /System/Library/Frameworks,
22 so it will start the version of Safari from the Applications directory with the WebKit frameworks you just built.</p>
23 </li>
24
25 </ol>
26
27 <p>If you have specified custom location for the build products directory in Xcode preferences, the frameworks will be built in that directory.
28 If you haven't, the build products will be put in a directory named WebKitBuild alongside the source code directories.</p>
29 <p>By default, the scripts will do a Release build, which is optimized and doesn't have debugging code, like assertions, compiled in.
30 If you'd prefer to do a Debug build, then execute this command:</p>
31 <p class="code">WebKitTools/Scripts/set-webkit-configuration --debug</p>
32 <p>You can also pass the configuration on the command line to any of the build commands.</p>
33 <p>More information about building WebKit can be found on its <a href="http://www.opendarwin.org/wiki/index.php/WebKit">wiki</a>.</p>
34
35 <?php
36         include("../footer.inc");
37 ?>