b6e9de85641de3da9e1a1119b51d334d760391a5
[WebKit-https.git] / WebKitSite / building / build.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <html>
3 <head>
4   <meta content="text/html; charset=ISO-8859-1"
5  http-equiv="content-type">
6   <title>Building WebKit</title>
7   <link rel=stylesheet href="../webkitdev.css">
8 </head>
9 <body>
10 <!--begin sidebar -->
11 <iframe id="sidebar" src="../sidebar.html"></iframe>
12 <!--end sidebar -->
13
14 <div id="banner">
15 Building WebKit
16 </div>
17
18 <div id="content">
19
20 <p>Before you build WebKit, you'll need to <a href="checkout.html">check out</a> sources.<p>
21
22 <ol>
23
24 <li><p>To start a build, use the <tt>build-webkit</tt> script.</p>
25 <p class="code">WebKitTools/Scripts/build-webkit</p>
26 <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>
27 </li>
28
29 <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>
30 <p class="code">WebKitTools/Scripts/run-safari</p>
31 <p>This script sets up the <tt>DYLD_FRAMEWORK_PATH</tt> environment variable, which will cause the system loader to use the
32 frameworks you built from your Xcode build products directory instead of the ones installed in /System/Library/Frameworks,
33 so it will start the version of Safari from the Applications directory with the WebKit frameworks you just built.</p>
34 </li>
35
36 </ol>
37
38 <p>If you have specified custom location for the build products directory in Xcode preferences, the frameworks will be built in that directory.
39 If you haven't, the build products will be put in a directory named WebKitBuild alongside the source code directories.</p>
40 <p>By default, the scripts will do a Deployment build, which is optimized and doesn't have development-only code, like assertions, compiled in.
41 If you're prefer to do a Development build, then do execute this command:</p>
42 <p class="code">WebKitTools/Scripts/set-webkit-configuration --development</p>
43 <p>You can also pass the configuration on the command line to any of the build commands.
44 If you're using Xcode 2.0 you'll need to blow away your build products directory each time you switch configurations.</p>
45 <p>More information about building WebKit can be found on its <a href="http://www.opendarwin.org/wiki/index.php/WebKit">wiki</a>.</p>
46 <p>[TODO: Talk about how to replace your system WebKit.framework, and why you probably don't want to, once we have scripts that help you do that.]</p>
47
48 </div>
49 </body>
50 </html>