Changeset 51733 in webkit


Ignore:
Timestamp:
Dec 5, 2009 4:30:28 PM (14 years ago)
Author:
eric@webkit.org
Message:

2009-12-05 Chris Jerdonek <​chris.jerdonek@gmail.com>

Reviewed by Darin Adler.

Refactored web site documentation so that advice to add
WebKitTools/Scripts to your shell path does not appear
on multiple pages.

​https://bugs.webkit.org/show_bug.cgi?id=32112

  • building/build.html:
  • building/checkout.html:
  • building/run.html:
  • coding/coding-style.html:
  • coding/contributing.html:
  • coding/scripts.html: Added.
  • quality/testing.html:
Location:
trunk/WebKitSite
Files:
1 added
7 edited

Legend:

Unmodified
Added
Removed

  • trunk/WebKitSite/ChangeLog

    r51723 r51733  
     12009-12-05  Chris Jerdonek  <chris.jerdonek@gmail.com>
     2
     3        Reviewed by Darin Adler.
     4
     5        Refactored web site documentation so that advice to add
     6        WebKitTools/Scripts to your shell path does not appear
     7        on multiple pages.
     8       
     9        https://bugs.webkit.org/show_bug.cgi?id=32112
     10       
     11        * building/build.html:
     12        * building/checkout.html:
     13        * building/run.html:
     14        * coding/coding-style.html:
     15        * coding/contributing.html:
     16        * coding/scripts.html: Added.
     17        * quality/testing.html:
     18
    1192009-12-04  Marc-Antoine Ruel  <maruel@chromium.org>
    220

  • trunk/WebKitSite/building/build.html

    r42629 r51733  
    1818
    1919<ol>
    20 <li><p>Type this command to build WebKit:</p>
    21 <p class="code">WebKit/WebKitTools/Scripts/build-webkit</p>
    22 <p>Use the <tt>--debug</tt> option for a debug build, which includes debugging symbols and assertions:</p>
    23 <p class="code">WebKit/WebKitTools/Scripts/build-webkit --debug</p>
     20<li><p>Run the <tt>build-webkit</tt> <a href="/coding/scripts.html">script</a>
     21to build WebKit.</p>
     22<p>Use the <tt>--debug</tt> option for a debug build, which includes
     23debugging symbols and assertions:</p>
     24<p class="code">build-webkit --debug</p>
    2425</li>
    2526</ol>
    … …  
    3940</div>
    4041
     42<p>Once your build has finished, you can <a href="run.html">run it inside
     43Safari.</a></p>
     44
    4145<h2>Setting a Default Configuration</h2>
    4246<ol>
    43 <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>
    44 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --debug</p>
    45 <p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --release</p>
     47<li><p>To set a default build configuration for <tt>build-webkit</tt> and
     48other <a href="/coding/scripts.html">scripts</a>, use the
     49<tt>set-webkit-configuration</tt> script:</p>
     50<p class="code">set-webkit-configuration --debug</p>
     51<p class="code">set-webkit-configuration --release</p>
    4652</li>
    4753</ol>
    48 
    49 <hr>
    50 <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>
    51 
    52 <p>Once your build has finished, you can <A href="run.html">run it inside Safari.</a></p>
    5354
    5455<?php

  • trunk/WebKitSite/building/checkout.html

    r39756 r51733  
    4141<div class="windows-instructions">
    4242<h4>Windows</h4>
     43<ol>
    4344<li><p>Install the WebKit Support Libraries</p>
    4445<p>Download the <a href="http://developer.apple.com/opensource/internet/webkit_sptlib_agree.html">WebKit Support Libraries</a> to the root of your source tree (<tt>C:\cygwin\home\&lt;username&gt;\WebKit</tt>).</p>
    4546<p>If the file is incorrectly named, rename it to <tt>WebKitSupportLibrary.zip</tt>. Do not extract its contents.</p>
     47</ol>
    4648</div>
    4749
    4850<ol>
    49 <li><p>Type this command to update your source tree:</p>
    50 <p class="code">WebKit/WebKitTools/Scripts/update-webkit</p>
     51<li><p>Run the <tt>update-webkit</tt> <a href="/coding/scripts.html">script</a>
     52to update your source tree.</p>
    5153<p>If you downloaded the tarball, this will bring it up to date.  Windows users
    5254must always execute this command after first obtaining the code, since it will
    … …  
    5860
    5961<h2>Keeping up to Date</h2>
    60 <p>At any time, you can retype the <tt>update-webkit</tt> command to update your source tree:</p>
    61 <p class="code">WebKit/WebKitTools/Scripts/update-webkit</p>
     62<p>At any time, you can rerun the <tt>update-webkit</tt> script to update
     63your source tree.</p>
    6264
    63 <hr>
    64 <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>
    6565<?php
    6666include("../footer.inc");

  • trunk/WebKitSite/building/run.html

    r23464 r51733  
    66<h2>Running WebKit</h2>
    77<ol>
    8 <li><p>Type this command to run Safari with the WebKit you built:</p>
    9 <p class="code">WebKit/WebKitTools/Scripts/run-safari</p>
     8<li><p>Execute the <tt>run-safari</tt> <a href="/coding/scripts.html">script</a>
     9to run Safari with the WebKit version you <a href="build.html">built</a>.</p>
    1010<p>Use the <tt>--debug</tt> option for a debug build:</p>
    11 <p class="code">WebKit/WebKitTools/Scripts/run-safari --debug</p>
     11<p class="code">run-safari --debug</p>
    1212</li>
    1313</ol>
    … …  
    2121<div class="windows-instructions">
    2222<h4>Windows</h4>
    23 <p>The <tt>run-safari</tt> script launches the Safari executable with the <tt>/frameworkPath</tt> command line switch set to point to your build products.  The <tt>/debug</tt> command line switch will be set if you pass --debug to run-safari.</p>
     23<p>The <tt>run-safari</tt> script launches the Safari executable with the <tt>/frameworkPath</tt> command line switch set to point to your build products.  The <tt>/debug</tt> command line switch will be set if you pass --debug to <tt>run-safari.</tt></p>
    2424</div>
    25 <hr>
    26 <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>
    2725
    2826<?php

  • trunk/WebKitSite/coding/coding-style.html

    r51587 r51733  
    743743
    744744<li>It is acceptable, however, to use "using" declarations at the end of
    745 header files in the WTF sub-libary to include one or more names in
     745header files in the WTF sub-library to include one or more names in
    746746the WTF namespace into the global scope.
    747747

  • trunk/WebKitSite/coding/contributing.html

    r51587 r51733  
    55<h2>Contributing Code</h2>
    66<p>Contributing code to the WebKit project is a straightforward process.
    7 Once you have the code <a href="/building/checkout.html">checked out</a>, <a href="/building/build.html">built</a>, and made your changes, you'll need to do a few things in order to get it landed in the tree:</p>
     7The project maintains several <a href="scripts.html">scripts</a>
     8to assist you with this process.</p>
     9
     10<p>Once you have <a href="/building/checkout.html">checked out</a>,
     11<a href="/building/build.html">built</a>, and made your changes to the code,
     12you'll need to do a few things to get your changes landed in the tree:</p>
     13
    814<ol>
    9     <li>Make sure your changes meet the <a href="/coding/coding-style.html">code style guidelines</a>. <tt>check-webkit-style</tt> may be of help.</li>
     15    <li>Make sure your changes meet the <a href="/coding/coding-style.html">code
     16        style guidelines</a>. The <tt>check-webkit-style</tt> script may be of
     17        help.</li>
    1018    <li>Run the layout tests using the <tt>run-webkit-tests</tt> script and make sure they all pass.
    1119        See the <a href="/quality/testwriting.html">testing page</a> for more information, as well as what you need to do if you've modified JavaScriptCore.</li>
    … …  
    1927</ol>
    2028
     29<p>More detail about these steps is below.</p>
    2130
    2231<h3>Code Style Guidelines</h3>
    … …  
    5261
    5362<h3>Create the patch</h3>
    54 <p>WebKit uses the <tt>svn-create-patch</tt> script to create patches.  <tt>svn-create-patch</tt> is just a small wrapper around Subversion's <tt>diff</tt> command which knows how to better handle moved, added, and deleted files. This command is best run from the top level of your checkout to make
    55 sure no changes are left out of your patch. It is not necessary to break a patch into multiple files.</p>
     63<p>WebKit uses <tt>svn-create-patch</tt> to create patches. The
     64<tt>svn-create-patch</tt> script is a small wrapper around Subversion's
     65<tt>diff</tt> command that better handles moved, added, and deleted files.
     66This command is best run from the top level of your checkout
     67to make sure no changes are left out of your patch. It is not necessary to
     68break a patch into multiple files.</p>
    5669
    57 <p><tt>svn-create-patch</tt> does not create a file automatically, you need to redirect the output yourself using something like: <tt>svn-create-patch > MyExcellentPatch.txt</tt></p>
     70<p>The <tt>svn-create-patch</tt> script does not create a file automatically.
     71You need to redirect the output yourself using something like--</p>
     72<p class="code">svn-create-patch > MyExcellentPatch.txt</p>
    5873
    5974<h3>Patch review</h3>
    60 <p>Once you have a patch file, it must be reviewed by one of the approved WebKit reviewers. To request a review, attach the patch
    61 to the bug report, and mark the patch with the flag <tt>review:?</tt>. The reviewer will typically either approve the patch
     75<p>Once you have a patch file, one of the approved WebKit reviewers must review it.
     76To request a review, attach the patch to the bug report, and mark the patch with the flag <tt>review:?</tt>. The reviewer will typically either approve the patch
    6277(by responding with an <tt>r=me</tt> in the bug report and marking the patch <tt>review:+</tt>) or request revisions
    6378to the patch (and mark the patch <tt>review:-</tt>). In rare cases a patch may be permanently rejected, meaning that the reviewer
    … …  
    7691<p>WebKit provides an automated system (commit-queue) for landing patches for any who would like to use it.  To use the commit-queue, set the <tt>commit-queue:?</tt> flag on your patch.  A committer will set <tt>commit-queue:+</tt> and an automated process will download, build, run the layout tests, and submit your patch on your behalf.  If the <a href="http://build.webkit.org/">WebKit buildbots</a> are passing, your patch should be landed within 15 minutes after <tt>commit-queue:+</tt> is set. See the <a href="https://trac.webkit.org/wiki/CommitQueue">commit-queue documentation</a> for more information.</p>
    7792
    78 <h2>WebKit Scripts</h2>
    79 <p><tt>WebKitTools/Scripts</tt> contains a number of scripts to help make life easier when submitting a patch. All scripts mentioned
    80 on this page (and on the rest of the site as well) are located here unless otherwise mentioned.</p>
    81 <p>It's handy to put this directory in your shell path so you can just type the commands without having to specify the path to
    82 the script each time.</p>
    83 
    8493<h2>Obtaining Commit and Review Privileges</h2>
    8594<p>Our <a href="commit-review-policy.html">Committer and Reviewer policy</a> provides details on obtaining commit and review privileges.</p>

  • trunk/WebKitSite/quality/testing.html

    r44604 r51733  
    77<h3>The WebKit Tests</h3>
    88
    9 <p>Before patches can land in any of the frameworks in the repository, the layout regression tests must be run. To run these tests, execute the <tt>run-webkit-tests</tt> script.</p>
    10 <p class="code">WebKitTools/Scripts/run-webkit-tests</p>
    11 <p>It's handy to put the <tt>WebKitTools/Scripts</tt> directory in your shell path so you can type commands like <tt>run-webkit-tests</tt> without specifying the path to the script.</p>
     9<p>Before patches can land in any of the frameworks in the repository, the
     10layout regression tests must pass. To run these tests, execute the
     11<tt>run-webkit-tests</tt> <a href="/coding/scripts.html">script</a>.</p>
    1212
    1313<p>The script will dump the render trees for all of the pages and diff the results against the expected correct results.  If no
    … …  
    6161<h3>How to run the tests</h3>
    6262
    63 <p>Execute the "run-javascriptcore-tests" script:</p>
    64 <p class="code">WebKitTools/Scripts/run-javascriptcore-tests</p>
    65 <p>The script will run all the tests and summarize how the results differ from what is currently expected.</p>
     63<p>Execute the <tt>run-javascriptcore-tests</tt> <a href="/coding/scripts.html">script</a>.
     64The script will run all the tests and summarize how the results differ
     65from what is currently expected.</p>
    6666
    6767<h3>What just happened</h3>
    … …  
    8181<h3>What happens if I caused a regression?</h3>
    8282
    83 <p>It's not the end of the world.  Go back and fix your bug and re-run <tt>run-javascriptcore-tests</tt>  as many times as necessary.</p>
     83<p>It's not the end of the world.  Go back and fix your bug and rerun
     84<tt>run-javascriptcore-tests</tt> as many times as necessary.</p>
    8485
    8586<?php
Note: See TracChangeset for help on using the changeset viewer.