Reviewed by Beth.
authorggaren <ggaren@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sat, 14 Oct 2006 01:37:15 +0000 (01:37 +0000)
committerggaren <ggaren@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Sat, 14 Oct 2006 01:37:15 +0000 (01:37 +0000)
        Split build, run, and debug steps into separate pages. Darin recommended
        this a while back.

        * building/build.html:
        * building/checkout.html:
        * building/debug.html: Added.
        * building/run.html: Added.
        * nav.inc:

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

WebKitSite/ChangeLog
WebKitSite/building/build.html
WebKitSite/building/debug.html [new file with mode: 0644]
WebKitSite/building/run.html [new file with mode: 0644]
WebKitSite/nav.inc

index c82fad12c4d65147dde7a9f654dd1eee23168d50..9f5f32a53ba76cb7066fb8e9290c4c4eded31907 100644 (file)
@@ -1,3 +1,16 @@
+2006-10-13  Geoffrey Garen  <ggaren@apple.com>
+
+        Reviewed by Beth.
+        
+        Split build, run, and debug steps into separate pages. Darin recommended
+        this a while back.
+
+        * building/build.html:
+        * building/checkout.html:
+        * building/debug.html: Added.
+        * building/run.html: Added.
+        * nav.inc:
+
 2006-10-05  Eric Seidel  <eric@eseidel.com>
 
         Reviewed by Tim H.
index b47f8988c2fe42beea0c28358399b4a644a7b890..9ad94718bf33c1622a8b3171d0855e30455ee054 100644 (file)
 <p>By default, <tt>build-webkit</tt> places build products in WebKit/WebKitBuild. If your Xcode preferences specify a custom build products location, <tt>build-webkit</tt> places build products there.</p>
 <p>More information about building WebKit is available on the <a href="http://wiki.webkit.org">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>
-<p>Use the <tt>--debug</tt> option for a debug build:</p>
-<p class="code">WebKit/WebKitTools/Scripts/run-safari --debug</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>
-
-<h2>Setting a Default</h2>
+<h2>Setting a Default Configuration</h2>
 <ol>
 <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>
 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --debug</p>
@@ -37,39 +26,9 @@ and then launches /Applications/Safari.app. <tt>DYLD_FRAMEWORK_PATH</tt> tells t
 </li>
 </ol>
 
-<h2>Debugging the WebKit You Built in Xcode</h2>
-<ol>
-<li><p>Open a project</p>
-<p>Each WebKit component -- JavaScriptCore, WebCore, and WebKit -- contains its own Xcode project. Open the project belonging to the component you want to debug.</p>
-</li>
-<li><p>Set the project's build products location</p>
-<p>To find the WebKit you built, Xcode needs to know the build products location that <tt>build-webkit</tt> used. You can set the build products location from the project's Info window.</p>
-<img src="info-tab.png">
-</li>
-<li><p>Set the project's active build configuration</p>
-<p>Xcode also needs to know the build configuration you used. You can set the active build configuration from the project's Build window.</p>
-<img src="build-window.png">
-</li>
-<li><p>Add a custom executable to the project</p>
-<p>Choose any WebKit application you want to use for debugging. To use Safari, select /Applications/Safari.app.</p>
-<img src="custom-executable.png">
-</li>
-<li><p>Set the project's active executable</p>
-<p>You can set the active executable from the project's Build window. Choose the executable you just added.</p>
-</li>
-<li><p>Close and re-open the project</p>
-<p>This will force Xcode to discover generated source files, which output to your build products location, allowing you to set breakpoints in them.</p>
-</li>
-<li><p>Launch the debugger</p>
-<p>In the Debugger window, click the "Debug" button.</p>
-<img src="debug.png">
-</li>
-</ol>
-
 <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>
 
-
 <?php
     include("../footer.inc");
 ?>
diff --git a/WebKitSite/building/debug.html b/WebKitSite/building/debug.html
new file mode 100644 (file)
index 0000000..c6884b9
--- /dev/null
@@ -0,0 +1,37 @@
+<?php
+    $title = "Debugging WebKit";
+    include("../header.inc");
+?>
+
+<h2>Debugging WebKit</h2>
+<ol>
+<li><p>Open a project</p>
+<p>Each WebKit component -- JavaScriptCore, WebCore, and WebKit -- contains its own Xcode project. Open the project belonging to the component you want to debug.</p>
+</li>
+<li><p>Set the project's build products location</p>
+<p>To find the WebKit you built, Xcode needs to know the build products location that <tt>build-webkit</tt> used. You can set the build products location from the project's Info window.</p>
+<img src="info-tab.png">
+</li>
+<li><p>Set the project's active build configuration</p>
+<p>Xcode also needs to know the build configuration you used. You can set the active build configuration from the project's Build window.</p>
+<img src="build-window.png">
+</li>
+<li><p>Add a custom executable to the project</p>
+<p>Choose any WebKit application you want to use for debugging. To use Safari, select /Applications/Safari.app.</p>
+<img src="custom-executable.png">
+</li>
+<li><p>Set the project's active executable</p>
+<p>You can set the active executable from the project's Build window. Choose the executable you just added.</p>
+</li>
+<li><p>Close and re-open the project</p>
+<p>This will force Xcode to discover generated source files, which output to your build products location, allowing you to set breakpoints in them.</p>
+</li>
+<li><p>Launch the debugger</p>
+<p>In the Debugger window, click the "Debug" button.</p>
+<img src="debug.png">
+</li>
+</ol>
+
+<?php
+    include("../footer.inc");
+?>
diff --git a/WebKitSite/building/run.html b/WebKitSite/building/run.html
new file mode 100644 (file)
index 0000000..be9a5e7
--- /dev/null
@@ -0,0 +1,22 @@
+<?php
+    $title = "Running WebKit";
+    include("../header.inc");
+?>
+
+<h2>Running WebKit</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>
+<p>Use the <tt>--debug</tt> option for a debug build:</p>
+<p class="code">WebKit/WebKitTools/Scripts/run-safari --debug</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>run-safari</tt> without specifying a full path.</p>
+
+<?php
+    include("../footer.inc");
+?>
index 40b09089d88141bc6f23fdd27b3e41ffff9ee7cf..fa38586b136524ec6b9195e347c04cf200c3ff17 100644 (file)
@@ -8,6 +8,8 @@
 
         <li><a href="/building/checkout.html">Getting the Code</a></li>
         <li><a href="/building/build.html">Building WebKit</a></li>
+        <li><a href="/building/run.html">Running WebKit</a></li>
+        <li><a href="/building/debug.html">Debugging WebKit</a></li>
         <li><a href="/coding/contributing.html">Contributing Code</a></li>
 
         <li class="subtitle">Documentation</li>