2010-10-19 Jenn Braithwaite <jennb@chromium.org>
[WebKit-https.git] / WebKitSite / building / tools.html
1 <?php
2 $title = "Installing Developer Tools";
3 include("../header.inc");
4 ?>
5 <h2>Installing the Developer Tools</h2>
6 <div class="mac-instructions">
7 <h4>Mac OS X</h4>
8 <ol>
9 <li><p>Install the Xcode Tools package</p>
10 <p>Install the Xcode Tools package from <a target="installtools" href="http://connect.apple.com/">http://connect.apple.com</a>.  Xcode 2.3 or later is required to build.</p>
11 <li><p>Install a Subversion Client (Tiger only)</p>
12 <p>Subversion (svn) is the source code management tool used by the WebKit Open Source Project. A <a target="installtools" href="http://www.collab.net/downloads/community/">Subversion client for Mac OS X 10.4 and later</a> is available.  Leopard (10.5) and later already include a subversion client.</p>
13 <li><p>Install Python 2.5 or later (Tiger only)</p>
14 <p>Python is a scripting language used by the WebKit Open Source Project. WebKit scripts require <a target="installtools" href="http://www.python.org/download/">Python 2.5 or later</a> to run.  Tiger includes Python 2.3 which is too old to support  <a target="installtools" href="http://trac.webkit.org/wiki/PythonGuidelines">WebKit's Python scripts</a>.</p>
15 </ol>
16 </div>
17
18 <div class="windows-instructions">
19 <h4>Windows</h4>
20 <ol>
21 <li><p>If you own Visual Studio 2005 (newer versions of Visual Studio are currently unsupported):</p>
22 <p>Install <a target="installtools" href="http://www.microsoft.com/downloads/details.aspx?familyid=BB4A75AB-E2D4-4C96-B39D-37BAF6B5B1DC&amp;displaylang=en">Microsoft Visual Studio 2005 Team Suite Service Pack 1</a>.</p>
23 <p>If you are building from Vista, install <a target="installtools" href="http://www.microsoft.com/downloads/details.aspx?FamilyID=90e2942d-3ad1-4873-a2ee-4acc0aace5b6&amp;displaylang=en">Service Pack 1 Update for Windows Vista</a>.</p>
24 <p>Install <a target="installtools" href="http://www.microsoft.com/downloads/details.aspx?FamilyID=7c8729dc-06a2-4538-a90d-ff9464dc0197&amp;displaylang=en">Visual Studio 2005 Service Pack 1 ATL Security Update</a>.</p>
25 <p>Install the following hotfixes to improve Visual Studio's performance and responsiveness:</p>
26 <ol>
27 <li><a target="installtools" href="http://code.msdn.microsoft.com/KB918559">KB918559</a></li>
28 <li><a target="installtools" href="http://code.msdn.microsoft.com/KB935225">KB935225</a></li>
29 <li><a target="installtools" href="http://code.msdn.microsoft.com/KB943969">KB943969</a></li>
30 <li><a target="installtools" href="http://code.msdn.microsoft.com/KB947315">KB947315</a></li>
31 </ol>
32 <p>Use the default options for these installations.</p>
33 <li><p>If not, you can use Visual C++ Express 2005 (newer versions of Visual C++ Express Edition are currently unsupported):</p>
34 <p>Install <a target="installtools" href="http://go.microsoft.com/fwlink/?LinkId=51410">Visual C++ 2005 Express</a>.</p>
35 <p>Install <a target="installtools" href="http://download.microsoft.com/download/7/7/3/7737290f-98e8-45bf-9075-85cc6ae34bf1/VS80sp1-KB926748-X86-INTL.exe">Microsoft Visual C++ Express 2005 Service Pack 1</a>.</p>
36 <p>If you are building from Vista, install <a target="installtools" href="http://www.microsoft.com/downloads/details.aspx?FamilyID=90e2942d-3ad1-4873-a2ee-4acc0aace5b6&amp;displaylang=en">Service Pack 1 Update for Windows Vista</a>.</p>
37 <p>Install <a target="installtools" href="http://www.microsoft.com/downloads/details.aspx?FamilyID=7c8729dc-06a2-4538-a90d-ff9464dc0197&amp;displaylang=en">Visual Studio 2005 Service Pack 1 ATL Security Update</a>.</p>
38 <p>Install the <a target="installtools" href="http://www.microsoft.com/downloads/details.aspx?familyid=0baf2b35-c656-4969-ace8-e4c0c0716adb&amp;displaylang=en">Windows Server 2003 R2 Platform SDK</a>, then follow steps 2 and 3 of &ldquo;<a target="installtools" href="http://msdn.microsoft.com/en-us/library/ms235626(VS.80).aspx">How to: Use Visual C++ Express Edition with the Microsoft Platform SDK</a>.&rdquo;</p>
39 <p>Use the default options for all installations.</p>
40 <p>In addition to the paths specified in step 3 of the Platform SDK installation instructions, you must also add the following include path. Update the Visual C++ directories in the Projects and Solutions section in the Options dialog box:</p>
41 <p style="font-size:10px">C:\Program Files\Microsoft Platform SDK for Windows Server 2003 R2\Include\mfc</p>
42
43 <li><p>Install Cygwin</p>
44 <p>Cygwin is a collection of utilities for Windows that includes not only a Subversion
45 client, but also additional tools that are required to build the WebKit source.  We
46 have made a downloader available that automatically collects all of the required
47 packages.
48 <p>Download <a
49 href="http://svn.webkit.org/repository/webkit/trunk/WebKitTools/CygwinDownloader/cygwin-downloader.zip">cygwin-downloader.zip</a>.</p>
50 <p>Right-click <code>cygwin-downloader.zip</code> and choose <b>Extract All...</b>.
51 Keep all the default options and click <b>Next</b> until the file is extracted and the cygwin-downloader folder opens.</p>
52 <p>Double-click <code>cygwin-downloader.exe</code>. This will download all the Cygwin packages you need.</p>
53 <p>When all the packages have finished downloading, the Cygwin installer will launch. Choose <b>Install from Local Directory</b>, then click <b>Next</b> until the install is complete. If you are running Vista, the installer won't be able to launch automatically, so you will have to manually launch Cygwin's Setup.exe.</p>
54 <P>Vista may warn you that Cygwin did not install correctly. Ignore this warning and tell Vista that the install was successful.</p>
55 <p>If you are running Vista, click on the Start menu, enter the following command, and press Enter:</p>
56 <p class="code">C:\cygwin\bin\ash -c /bin/rebaseall</p>
57
58 <li><p>Install QuickTime SDK</p>
59 <p>Download QuickTime SDK for Windows from <a href="http://developer.apple.com/quicktime/download/">http://developer.apple.com/quicktime/download/</a> and install it to the default location (\Program Files\QuickTime SDK). This is needed for media support.
60
61 <li><p>Install DirectX SDK</p>
62 <p>Download the <a href="http://msdn.microsoft.com/en-us/directx/default.aspx">DirectX SDK</a>.  This is needed for accelerated compositing on Windows.</p>
63 <p> Verify MSVC|Tools|Options|Projects and Solutions|VC++ Directories has Include: <code>$(DXSDK_DIR)include</code> and Lib: <code>$(DXSDK_DIR)lib</code> 
64 </p>
65
66 <li><p>Optional: Install the 32-bit version of Debugging Tools for Windows</p>
67 <p>Debugging Tools for Windows includes many useful debugging tools such as WinDbg and NTSD. Some of WebKit&rsquo;s tests and scripts use these tools. Follow the <a target="installtools" href="http://www.microsoft.com/whdc/devtools/debugging/installx86.mspx#b">instructions for installing the 32-bit version of Debugging Tools for Windows</a>.</p>
68 <li><p>Optional: Hotfix for 64-bit Windows to disable the user-mode callback filter for exceptions</p>
69 <p>Without the <a href="http://support.microsoft.com/kb/976038">976038 hotfix</a>, exceptions may be thrown in callback routines that do not cause a crash but leave the application in an inconsistent state that might cause a crash later. You will need to click on "View and request hotfix downloads" and fill out the form. A link to download the hotfix and a password will be emailed to you.</p>
70 </ol>
71 </div>
72
73 <div class="gtk-instructions">
74 <h4>GTK</h4>
75 Follow the instructions on the <a href="http://trac.webkit.org/wiki/BuildingGtk">BuildingGTK</a> wiki page.
76 </div>
77
78 <div class="qt-instructions">
79 <h4>QT</h4>
80 Follow the instructions on the <a href="http://trac.webkit.org/wiki/QtWebKit">QtWebKit</a> wiki page.
81 </div>
82
83 <p>Once you have installed your developer tools, the next step is
84 <a href="checkout.html">getting the code</a>.</p>
85 <?php
86 include("../footer.inc");
87 ?>