webkit.org instructions for debugging WebProcess are unnecessarily complex
authormitz@apple.com <mitz@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 7 May 2012 17:42:07 +0000 (17:42 +0000)
committermitz@apple.com <mitz@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 7 May 2012 17:42:07 +0000 (17:42 +0000)
https://bugs.webkit.org/show_bug.cgi?id=85756

Reviewed by Darin Adler.

* building/debug.html: Added instructions for setting up and using the WebKit workspace for
debugging the Web process, as well as instructions for debugging the Web process from the
command line using debug-safari and debug-minibrowser.
* building/tools.html: Updated links and tweaked the language.

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

Websites/webkit.org/ChangeLog
Websites/webkit.org/building/debug.html
Websites/webkit.org/building/tools.html

index 578fbcf..be149b6 100644 (file)
@@ -1,3 +1,15 @@
+2012-05-07  Dan Bernstein  <mitz@apple.com>
+
+        webkit.org instructions for debugging WebProcess are unnecessarily complex
+        https://bugs.webkit.org/show_bug.cgi?id=85756
+
+        Reviewed by Darin Adler.
+
+        * building/debug.html: Added instructions for setting up and using the WebKit workspace for
+        debugging the Web process, as well as instructions for debugging the Web process from the
+        command line using debug-safari and debug-minibrowser.
+        * building/tools.html: Updated links and tweaked the language.
+
 2012-04-23  Daniel Bates  <dbates@webkit.org>
 
         Add notice about running xcode-select before using Xcode 4.3.2 command line tools
index 4d4331f..3d1e7de 100644 (file)
@@ -5,23 +5,20 @@
 
 <div class="mac-instructions">
 <h2>Debugging on Mac OS X</h2>
-<p>Each WebKit component -- JavaScriptCore, WebCore, and WebKit2 -- contains its own Xcode project that depends on the build location specified in the project itself. In Xcode 4.3.2, choose Xcode > Preferences > Locations, click Locations, click the Advanced button, and ensure that the build location is Legacy.</p>
+<p>To debug from within Xcode, you can use the WebKit workspace. Ensure that the Products and Intermediates locations for the workspace match those used by <code>build-webkit</code> by choosing File > Workspace Settings and clicking the Advanced button, selecting Custom, Relative to Workspace, and entering WebKitBuild both for Products and for Intermediates. Note that if you have specified a custom build location in Xcode preferences, then you don&rsquo;t need to do this.</p>
 <h3>Debugging UIProcess</h3>
 <p>Follow the instructions on the <a href="debug-mac-uiprocess.html">debugging UIProcess</a> page.</p>
 <h3>Debugging WebProcess</h3>
-<ol>
-<li><p>Launch Safari</p>
-<p>Follow the instructions on <a href="run.html">Running WebKit</a> to launch Safari from the command line with the WebKit version you built. Alternatively you can <a href="debug-mac-uiprocess.html">use the WebKit2 Xcode project to launch Safari</a>.</p>
-</li>
-<li><p>Open a project</p>
-<p>Open the Xcode project belonging to the component -- WebCore or JavaScriptCore -- you want to debug.</p>
-</li>
-<li><p>Attach to WebProcess</p>
-<p>Choose Product > Attach to Process > WebProcess.</p>
-</li>
-<li><p>See the <a href="https://developer.apple.com/library/mac/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/Debugging/Debugging.html#//apple_ref/doc/uid/TP40010215-CH3-SW1">Xcode Debugging Guide</a> for more information on using Xcode to debug software on Mac OS X.</p>
-</li>
-</ol>
+<ul>
+    <li>
+        <p>From the command line:</p>
+        <p>Execute the <code>debug-safari</code> or <code>debug-minibrowser</code> <a href="/coding/scripts.html">script</a> with the <code>--target-web-process</code> option. It will start the debugger with WebProcess as the target and with command-line arguments that will make WebProcess run Safari or MiniBrowser as its client. At the debugger prompt, enter <code>run</code> to start the process.</p>
+    </li>
+    <li>
+        <p>From Xcode:</p>
+        <p>Open the WebKit workspace and choose &ldquo;All Source (target WebProcess)&rdquo; from the Scheme pop-up menu in the toolbar, then choose Product > Run. If WebKit is already built, it is quicker to choose Product > Perform Action > Run Without Building</p>
+    </li>
+</ul>
 </div>
 <div class="windows-instructions">
 <h2>Debugging on Windows</h2>
index 5325c75..398ab0d 100644 (file)
@@ -6,14 +6,14 @@ include("../header.inc");
 <div class="mac-instructions">
 <h4>Mac OS X</h4>
 <ol>
-<li><p>Install the Xcode Tools package</p>
-<p>Install the Xcode Tools package from <a target="installtools" href="http://connect.apple.com/">http://connect.apple.com</a>.  Xcode 3.1.4 or later is required to build.</p>
+<li><p>Install Xcode</p>
+<p>Get Xcode from <a target="installtools" href="https://developer.apple.com/downloads">https://developer.apple.com/downloads</a>.  Xcode 3.1.4 or later is required to build.</p>
 <li><p>Install the Xcode Command Line Tools (located under Xcode Preferences > Downloads)</p>
   <p><b>Note:</b> Before you can use the Xcode 4.3.2 tools, you must either run <code>sudo xcode-select -switch /Applications/Xcode.app</code> or
-set the environment variable DEVELOPER_DIR to <code>/Applications/Xcode.app/Contents/Developer</code>. See <code>man xcode-select</code> for more details.</p>
-  <p><b>Note:</b> This step is not required for versions of Xcode older than 4.3.</p>
+set the environment variable DEVELOPER_DIR to <code>/Applications/Xcode.app/Contents/Developer</code>. See <a href="x-man-page://xcode-select">the <code>xcode-select</code> man page</a> for more details.</p>
+  <p><b>Note:</b> This step is not required for versions of Xcode earlier than 4.3.</p>
 <li><p>Install Java for Mac OS X Developer Package</p>
-<p>Download and install the latest OS-appropriate "Java for Mac OS X Developer Package" from <a href="http://connect.apple.com/">http://connect.apple.com/</a> (located under Downloads > Java).</p>
+<p>Download and install the latest OS-appropriate &ldquo;Java for Mac OS X Developer Package&rdquo; from <a target="installtools" href="https://developer.apple.com/downloads">https://developer.apple.com/downloads</a>.</p>
 </ol>
 </div>