View snapshots are sometimes taken at the wrong scale
[WebKit-https.git] / Websites / webkit.org / coding / scripts.html
1 <?php
2     $title="WebKit Scripts";
3     include("../header.inc");
4 ?>
5 <h2>WebKit Scripts</h2>
6
7 <p>The WebKit project maintains several scripts to assist with things
8 like building and testing code, checking style, and preparing patches.<p>
9
10 <p>The <tt>Tools/Scripts</tt>
11 <a href="http://trac.webkit.org/browser/trunk/Tools/Scripts">folder</a>
12 of the WebKit source tree contains these scripts.
13 In fact, unless otherwise mentioned, all of the scripts mentioned
14 on this site are located in this folder.</p>
15
16 <h3>Running a script</h3>
17
18 <p>To run the <tt>build-webkit</tt> script, for example, type the
19 following from the command line:</p>
20
21 <p class="code">WebKit/Tools/Scripts/build-webkit</p>
22
23 <p>Similarly, to run the <tt>build-webkit</tt> script with the
24 <tt>--help</tt> option, type the following:<p>
25
26 <p class="code">WebKit/Tools/Scripts/build-webkit --help</p>
27
28 <h3>Adding to your path</h3>
29
30 <p>It is convenient to add <tt>WebKit/Tools/Scripts</tt> to your
31 shell path so you can run WebKit scripts without typing the full path.<p>
32
33 <p>For example, this will allow you to type the following for the two
34 examples above:</p>
35
36 <p class="code">build-webkit</p>
37 <p class="code">build-webkit --help</p>
38
39 <p>The instructions throughout this site assume you have added
40 <tt>WebKit/Tools/Scripts</tt> to your shell path.
41 If you do not add this directory to your shell path, simply always include
42 the full path as in the first examples above.</p>
43
44 <?php
45     include("../footer.inc");
46 ?>