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">WebKit source tree.</a>.
  10
  11 <ol>
  12 <li><p>Type this command to build WebKit:</p>
  13 <p class="code">WebKit/WebKitTools/Scripts/build-webkit</p>
  14 <p>Use the <tt>--debug</tt> option for a debug build, which includes debugging symbols and assertions:</p>
  15 <p class="code">WebKit/WebKitTools/Scripts/build-webkit --debug</p>
  16 </li>
  17 </ol>
  18
  19 <p>By default, <tt>build-webkit</tt> places build products in <tt>WebKit/WebKitBuild</tt>.  You can specify a different build
  20 location on Mac in your Xcode preferences.  On Windows, the <tt>WEBKITOUTPUTDIR</tt> environment variable can be used to
  21 set a different build products location.  If you have set up a custom build location, then <tt>build-webkit</tt> will
  22 place the build products there.</p>
  23
  24 <h2>Setting a Default Configuration</h2>
  25 <ol>
  26 <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>
  27 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --debug</p>
  28 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --release</p>
  29 </li>
  30 </ol>
  31
  32 <hr>
  33 <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>
  34
  35 <p>Once your build has finished, you can <A href="run.html">run it inside Safari.</a></p>
  36
  37 <?php
  38     include("../footer.inc");
  39 ?>