Reviewed by Beth.
authorggaren <ggaren@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sun, 30 Jul 2006 23:02:09 +0000 (23:02 +0000)
committerggaren <ggaren@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sun, 30 Jul 2006 23:02:09 +0000 (23:02 +0000)
        - Tweaked the checkout and build instructions to make them simpler and
        clearer.

        * building/build.html:
        * building/checkout.html:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@15700 268f45cc-cd09-0410-ab3c-d52691b4dbfc

WebKitSite/ChangeLog
WebKitSite/building/build.html
WebKitSite/building/checkout.html

index 28de236..bd42844 100644 (file)
@@ -1,3 +1,13 @@
+2006-07-30  Geoffrey Garen  <ggaren@apple.com>
+
+        Reviewed by Beth.
+        
+        - Tweaked the checkout and build instructions to make them simpler and
+        clearer.
+
+        * building/build.html:
+        * building/checkout.html:
+
 2006-06-22  Alexey Proskuryakov  <ap@nypop.com>
 
         Reviewed by Darin.
index 1818b65..9d3368b 100644 (file)
@@ -5,31 +5,35 @@
 
 <h2>Building WebKit</h2>
 
-<p>Before you build WebKit, you'll need to <a href="checkout.html">check out</a> sources. Next make sure that you have Xcode 2.3, which is the latest version at this point.<p>
+<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>
 
 <ol>
-
-<li><p>To start a build, use the <tt>build-webkit</tt> script.</p>
-<p class="code">WebKitTools/Scripts/build-webkit</p>
-<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>
+<li><p>Type this command to build WebKit:</p>
+<p class="code">WebKit/WebKitTools/Scripts/build-webkit</p>
+<p>Use the <tt>--debug</tt> option for a debug build, which includes debugging symbols and assertions:</p>
+<p class="code">WebKit/WebKitTools/Scripts/build-webkit --debug</p>
 </li>
-
-<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>
-<p class="code">WebKitTools/Scripts/run-safari</p>
-<p>This script sets up the <tt>DYLD_FRAMEWORK_PATH</tt> environment variable, which will cause the system loader to use the
-frameworks you built from your Xcode build products directory instead of the ones installed in /System/Library/Frameworks,
-so it will start the version of Safari from the Applications directory with the WebKit frameworks you just built.</p>
+<li><p>To set a default build configuration for <tt>build-webkit</tt>, use the <tt>set-webkit-configuration</tt> script:</p>
+<p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --debug</p>
+<p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --release</p>
 </li>
+</ol>
+
+<p>By default, <tt>build-webkit</tt> places build products in WebKit/WebKitBuild. If your Xcode preferences specify a custom build products location, <tt>webkit-build</tt> places build products there.</p>
+<p>More information about building WebKit is available on the <a href="http://www.opendarwin.org/wiki/index.php/WebKit">WebKit Wiki</a>.</p>
 
+<h2>Running Safari with the WebKit You Built</h2>
+<ol>
+<li><p>Type this command to run Safari with the WebKit you built:</p>
+<p class="code">WebKit/WebKitTools/Scripts/run-safari</p>
+</li>
 </ol>
+<p>The <tt>run-safari</tt> script sets the <tt>DYLD_FRAMEWORK_PATH</tt> environment variable to point to your build products, 
+and then launches /Applications/Safari.app. <tt>DYLD_FRAMEWORK_PATH</tt> tells the system loader to prefer your build products over the frameworks installed in /System/Library/Frameworks.</p>
+
+<hr>
+<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>
 
-<p>If you have specified custom location for the build products directory in Xcode preferences, the frameworks will be built in that directory.
-If you haven't, the build products will be put in a directory named WebKitBuild alongside the source code directories.</p>
-<p>By default, the scripts will do a Release build, which is optimized and doesn't have debugging code, like assertions, compiled in.
-If you'd prefer to do a Debug build, then execute this command:</p>
-<p class="code">WebKitTools/Scripts/set-webkit-configuration --debug</p>
-<p>You can also pass the configuration on the command line to any of the build commands.</p>
-<p>More information about building WebKit can be found on its <a href="http://www.opendarwin.org/wiki/index.php/WebKit">wiki</a>.</p>
 
 <?php
        include("../footer.inc");
index 5263411..8b6f447 100644 (file)
@@ -2,27 +2,29 @@
 $title = "Getting the Code";
 include("../header.inc");
 ?>
-<h2>Getting the Code</h2>
-
-<p>Below are step by step instructions for how to check out the WebKit source code.
-One of our contributors, Mark Rowe, has also made available <a href="http://nightly.webkit.org/">WebKit nightly builds</a> for those just interested in testing.
-Follow the instructions below to obtain the code via subversion (svn).</p>
+<h2>Getting WebKit</h2>
+<p>To download a pre-built bundle containing the latest WebKit, visit <a href="http://nightly.webkit.org/">WebKit Nightly Builds</a>, maintained by Mark Rowe.</p>
 
+<h2>Getting the Code</h2>
+<p>To download the WebKit source tree:</p>
 <ol>
-<li><p>Install a Subversion Client.</p>
-<p>The Subversion (svn) tool is required to access the WebKit source code.  Download the 
-Mac OS X <a href="http://metissian.com/downloads/macosx/subversion/subversion-client-1.3.1.dmg">Subversion installer</a> and double-click to install.</p>
-<li><p>Open the Terminal application.</p>
-<p>Terminal can be found in the Utilities folder; a quick way to open the folder is the Finder Go menu.</p>
-<li><p>Type this command to check out the entire WebKit source tree:</p>
+<li><p>Install a Subversion Client</p>
+<p>Subversion (svn) is the source code management tool used by the WebKit OpenSource Project. To download the
+Mac OS X Subversion client, <a href="http://metissian.com/downloads/macosx/subversion/subversion-client-1.3.1.dmg">click here</a>.</p>
+<li><p>Open Terminal</p>
+<p>Terminal resides in /Applications/Utilities. The Finder Go menu provides a quick way to navigate there.</p>
+<li><p>Type this command to check out the WebKit source tree:</p>
 <p class="code">svn checkout svn://anonsvn.opensource.apple.com/svn/webkit/trunk WebKit</p>
 </li>
-<p>After the checkout completes you should have all the source code on your system.  The next step is
-<a href="build.html">building</a> the code.</p>
 </ol>
-<p>Once you have checked out the code, you can update it at any time using the following command:</p>
-<p class="code">WebKitTools/Scripts/update-webkit</p>
-<p>It's handy to put the <tt>WebKitTools/Scripts</tt> directory in your shell path so you can type commands like <tt>update-webkit</tt> without specifying the path to the script.</p>
+<p>Once the checkout has finished, the next step is
+<a href="build.html">building WebKit</a>.</p>
+
+<h2>Keeping up to Date</h2>
+<p>Type this command to update your source tree:</p>
+<p class="code">WebKit/WebKitTools/Scripts/update-webkit</p>
+<hr>
+<p>It's handy to put <tt>WebKit/WebKitTools/Scripts</tt> in your shell path so you can type commands like <tt>update-webkit</tt> without specifying a full path.</p>
 <?php
 include("../footer.inc");
 ?>