4fbda8e6fbcdc82a4a9a4c57ef1bbf14d68312cc
[WebKit-https.git] / Websites / webkit.org / 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 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>.</p>
10
11 <div class="windows-instructions">
12 <h4>Windows</h4>
13 <p>Building on Windows requires a few more steps.  For details, see <a href="http://trac.webkit.org/wiki/BuildingOnWindows">http://trac.webkit.org/wiki/BuildingOnWindows</a>.</p>
14 </div>
15
16 <ol>
17 <li><p>Run the <code>build-webkit</code> <a href="/coding/scripts.html">script</a>
18 to build WebKit.</p>
19 <p>Use the <code>--debug</code> option for a debug build, which includes
20 debugging symbols and assertions:</p>
21 <p class="code">build-webkit --debug</p>
22 </li>
23 </ol>
24
25 <p>By default, <code>build-webkit</code> places build products in <code>WebKitBuild</code>.  You can specify a different build
26 location on Mac in your Xcode preferences.  On other platforms, the <code>WEBKIT_OUTPUTDIR</code> environment variable can be used to
27 set a different build products location. If you have set up a custom build location, then <code>build-webkit</code> will
28 place the build products there.</p>
29
30 <p>Once your build has finished, you can <a href="run.html">run Safari using
31 your custom WebKit build.</a></p>
32
33 <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>
34
35 <h2>Setting a Default Configuration</h2>
36 <p>To set a default build configuration for <code>build-webkit</code> and
37 other <a href="/coding/scripts.html">scripts</a>, use the
38 <code>set-webkit-configuration</code> script:</p>
39 <p class="code">set-webkit-configuration --debug</p>
40 <p class="code">set-webkit-configuration --release</p>
41 </ol>
42
43 <h2>Building WebKit from Xcode</h2>
44 <p>To build from within Xcode, you can use the WebKit workspace.  Before you build in Xcode:</p>
45
46 <ol>
47 <li>Build WebKit at least once using the command-line instructions above.  Be sure to build using
48     the same configuration on the command line as you intend to use in Xcode (typically debug).</li>
49 <li><p>Ensure that the Products and Intermediates locations for the workspace match those used by <code>build-webkit</code> by choosing File > Workspace Settings. Then click the Advanced button, select Custom, Relative to Workspace, and enter <code>WebKitBuild</code> for both Products and Intermediates.</p>
50     <p>Note that if you have specified a custom build location in Xcode preferences, then you don&rsquo;t need to do this.</p></li>
51 <li>If you get unexpected include or linker errors, try deleting the entire WebKitBuild directory, then rebuilding
52     on the command line <b>before</b> you try to build in Xcode.</li>
53 </ol>
54
55 <?php
56     include("../footer.inc");
57 ?>