[SCM] WebKit Debian packaging branch, webkit-1.2, updated. upstream/1.1.90-6072-g9a69373
eric at webkit.org
eric at webkit.org
Thu Apr 8 00:21:52 UTC 2010
The following commit has been merged in the webkit-1.2 branch:
commit 8f6aaff1f1336f8ae6c2cdcc03751d5c86c76a56
Author: eric at webkit.org <eric at webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date: Sun Dec 6 00:30:28 2009 +0000
2009-12-05 Chris Jerdonek <chris.jerdonek at 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:
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@51733 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebKitSite/ChangeLog b/WebKitSite/ChangeLog
index 5a628cb..b33c14d 100644
--- a/WebKitSite/ChangeLog
+++ b/WebKitSite/ChangeLog
@@ -1,3 +1,21 @@
+2009-12-05 Chris Jerdonek <chris.jerdonek at 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:
+
2009-12-04 Marc-Antoine Ruel <maruel at chromium.org>
Reviewed by Eric Seidel.
diff --git a/WebKitSite/building/build.html b/WebKitSite/building/build.html
index 628622e..0a1a503 100644
--- a/WebKitSite/building/build.html
+++ b/WebKitSite/building/build.html
@@ -17,10 +17,11 @@ installed</a> and that you have a copy of the <a href="checkout.html">WebKit sou
</div>
<ol>
-<li><p>Type this command to build WebKit:</p>
-<p class="code">WebKit/WebKitTools/Scripts/build-webkit</p>
-<p>Use the <tt>--debug</tt> option for a debug build, which includes debugging symbols and assertions:</p>
-<p class="code">WebKit/WebKitTools/Scripts/build-webkit --debug</p>
+<li><p>Run the <tt>build-webkit</tt> <a href="/coding/scripts.html">script</a>
+to build WebKit.</p>
+<p>Use the <tt>--debug</tt> option for a debug build, which includes
+debugging symbols and assertions:</p>
+<p class="code">build-webkit --debug</p>
</li>
</ol>
@@ -38,19 +39,19 @@ are still there and add them again if necessary.</p>
<p>Don't forget that if you have any questions or problems building WebKit, feel free to <a href="/contact.html">get in touch!</a></p>
</div>
+<p>Once your build has finished, you can <a href="run.html">run it inside
+Safari.</a></p>
+
<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>
-<p class="code">WebKit/WebKitTools/Scripts/set-webkit-configuration --release</p>
+<li><p>To set a default build configuration for <tt>build-webkit</tt> and
+other <a href="/coding/scripts.html">scripts</a>, use the
+<tt>set-webkit-configuration</tt> script:</p>
+<p class="code">set-webkit-configuration --debug</p>
+<p class="code">set-webkit-configuration --release</p>
</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>
-
-<p>Once your build has finished, you can <A href="run.html">run it inside Safari.</a></p>
-
<?php
include("../footer.inc");
?>
diff --git a/WebKitSite/building/checkout.html b/WebKitSite/building/checkout.html
index cd9ff74..5d7f377 100644
--- a/WebKitSite/building/checkout.html
+++ b/WebKitSite/building/checkout.html
@@ -40,14 +40,16 @@ to install Subversion.</p>
<div class="windows-instructions">
<h4>Windows</h4>
+<ol>
<li><p>Install the WebKit Support Libraries</p>
<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\<username>\WebKit</tt>).</p>
<p>If the file is incorrectly named, rename it to <tt>WebKitSupportLibrary.zip</tt>. Do not extract its contents.</p>
+</ol>
</div>
<ol>
-<li><p>Type this command to update your source tree:</p>
-<p class="code">WebKit/WebKitTools/Scripts/update-webkit</p>
+<li><p>Run the <tt>update-webkit</tt> <a href="/coding/scripts.html">script</a>
+to update your source tree.</p>
<p>If you downloaded the tarball, this will bring it up to date. Windows users
must always execute this command after first obtaining the code, since it will
download additional libraries that are needed to build.</p>
@@ -57,11 +59,9 @@ download additional libraries that are needed to build.</p>
<a href="build.html">building WebKit</a>.</p>
<h2>Keeping up to Date</h2>
-<p>At any time, you can retype the <tt>update-webkit</tt> command to update your source tree:</p>
-<p class="code">WebKit/WebKitTools/Scripts/update-webkit</p>
+<p>At any time, you can rerun the <tt>update-webkit</tt> script to update
+your source tree.</p>
-<hr>
-<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>
<?php
include("../footer.inc");
?>
diff --git a/WebKitSite/building/run.html b/WebKitSite/building/run.html
index ea15273..3fa24bd 100644
--- a/WebKitSite/building/run.html
+++ b/WebKitSite/building/run.html
@@ -5,10 +5,10 @@
<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>
+<li><p>Execute the <tt>run-safari</tt> <a href="/coding/scripts.html">script</a>
+to run Safari with the WebKit version you <a href="build.html">built</a>.</p>
<p>Use the <tt>--debug</tt> option for a debug build:</p>
-<p class="code">WebKit/WebKitTools/Scripts/run-safari --debug</p>
+<p class="code">run-safari --debug</p>
</li>
</ol>
@@ -20,10 +20,8 @@ and then launches /Applications/Safari.app. <tt>DYLD_FRAMEWORK_PATH</tt> tells t
<div class="windows-instructions">
<h4>Windows</h4>
-<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>
+<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>
</div>
-<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");
diff --git a/WebKitSite/coding/coding-style.html b/WebKitSite/coding/coding-style.html
index 6be0ae6..d8c740b 100644
--- a/WebKitSite/coding/coding-style.html
+++ b/WebKitSite/coding/coding-style.html
@@ -742,7 +742,7 @@ class VectorBuffer {
</li>
<li>It is acceptable, however, to use "using" declarations at the end of
-header files in the WTF sub-libary to include one or more names in
+header files in the WTF sub-library to include one or more names in
the WTF namespace into the global scope.
<h4 class="right">Right:</h4>
diff --git a/WebKitSite/coding/contributing.html b/WebKitSite/coding/contributing.html
index c9063cc..4ebcc94 100644
--- a/WebKitSite/coding/contributing.html
+++ b/WebKitSite/coding/contributing.html
@@ -4,9 +4,17 @@
?>
<h2>Contributing Code</h2>
<p>Contributing code to the WebKit project is a straightforward process.
-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>
+The project maintains several <a href="scripts.html">scripts</a>
+to assist you with this process.</p>
+
+<p>Once you have <a href="/building/checkout.html">checked out</a>,
+<a href="/building/build.html">built</a>, and made your changes to the code,
+you'll need to do a few things to get your changes landed in the tree:</p>
+
<ol>
- <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>
+ <li>Make sure your changes meet the <a href="/coding/coding-style.html">code
+ style guidelines</a>. The <tt>check-webkit-style</tt> script may be of
+ help.</li>
<li>Run the layout tests using the <tt>run-webkit-tests</tt> script and make sure they all pass.
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>
<li>Add any new files and layout tests to Subversion using the <tt>svn add</tt> command.</li>
@@ -18,6 +26,7 @@ Once you have the code <a href="/building/checkout.html">checked out</a>, <a hre
<li>Please watch for any regressions it may have caused (hopefully none)!</li>
</ol>
+<p>More detail about these steps is below.</p>
<h3>Code Style Guidelines</h3>
<p>Patches must comply with the <a href="/coding/coding-style.html">code style guidelines</a>.
@@ -51,14 +60,20 @@ More information on Subversion commands can be found via <tt>svn help</tt> or th
<p>The line WARNING: NO TEST CASES ADDED OR CHANGED appears if prepare-ChangeLog did not detect the addition of test cases. If your patch does not require test cases (or test cases are not possible), you should include a line stating such. Otherwise all changes require test cases which should be mentioned in the ChangeLog.</p>
<h3>Create the patch</h3>
-<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
-sure no changes are left out of your patch. It is not necessary to break a patch into multiple files.</p>
+<p>WebKit uses <tt>svn-create-patch</tt> to create patches. The
+<tt>svn-create-patch</tt> script is a small wrapper around Subversion's
+<tt>diff</tt> command that better handles moved, added, and deleted files.
+This command is best run from the top level of your checkout
+to make sure no changes are left out of your patch. It is not necessary to
+break a patch into multiple files.</p>
-<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>
+<p>The <tt>svn-create-patch</tt> script does not create a file automatically.
+You need to redirect the output yourself using something like--</p>
+<p class="code">svn-create-patch > MyExcellentPatch.txt</p>
<h3>Patch review</h3>
-<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
-to the bug report, and mark the patch with the flag <tt>review:?</tt>. The reviewer will typically either approve the patch
+<p>Once you have a patch file, one of the approved WebKit reviewers must review it.
+To 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
(by responding with an <tt>r=me</tt> in the bug report and marking the patch <tt>review:+</tt>) or request revisions
to the patch (and mark the patch <tt>review:-</tt>). In rare cases a patch may be permanently rejected, meaning that the reviewer
believes the feature should never be committed to the tree. The review process can consist of multiple iterations between you and
@@ -75,12 +90,6 @@ the reviewer as revisions are made to your patch.</p>
<h4 id="commitqueue">Optional: Use of the WebKit Commit Bot</h4>
<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>
-<h2>WebKit Scripts</h2>
-<p><tt>WebKitTools/Scripts</tt> contains a number of scripts to help make life easier when submitting a patch. All scripts mentioned
-on this page (and on the rest of the site as well) are located here unless otherwise mentioned.</p>
-<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
-the script each time.</p>
-
<h2>Obtaining Commit and Review Privileges</h2>
<p>Our <a href="commit-review-policy.html">Committer and Reviewer policy</a> provides details on obtaining commit and review privileges.</p>
diff --git a/WebKitSite/coding/scripts.html b/WebKitSite/coding/scripts.html
new file mode 100644
index 0000000..a5b3bd3
--- /dev/null
+++ b/WebKitSite/coding/scripts.html
@@ -0,0 +1,46 @@
+<?php
+ $title="WebKit Scripts";
+ include("../header.inc");
+?>
+<h2>WebKit Scripts</h2>
+
+<p>The WebKit project maintains several scripts to assist with things
+like building and testing code, checking style, and preparing patches.<p>
+
+<p>The <tt>WebKitTools/Scripts</tt>
+<a href="http://trac.webkit.org/browser/trunk/WebKitTools/Scripts">folder</a>
+of the WebKit source tree contains these scripts.
+In fact, unless otherwise mentioned, all of the scripts mentioned
+on this site are located in this folder.</p>
+
+<h3>Running a script</h3>
+
+<p>To run the <tt>build-webkit</tt> script, for example, type the
+following from the command line:</p>
+
+<p class="code">WebKit/WebKitTools/Scripts/build-webkit</p>
+
+<p>Similarly, to run the <tt>build-webkit</tt> script with the
+<tt>--help</tt> option, type the following:<p>
+
+<p class="code">WebKit/WebKitTools/Scripts/build-webkit --help</p>
+
+<h3>Adding to your path</h3>
+
+<p>It is convenient to add <tt>WebKit/WebKitTools/Scripts</tt> to your
+shell path so you can run WebKit scripts without typing the full path.<p>
+
+<p>For example, this will allow you to type the following for the two
+examples above:</p>
+
+<p class="code">build-webkit</p>
+<p class="code">build-webkit --help</p>
+
+<p>The instructions throughout this site assume you have added
+<tt>WebKit/WebKitTools/Scripts</tt> to your shell path.
+If you do not add this directory to your shell path, simply always include
+the full path as in the first examples above.</p>
+
+<?php
+ include("../footer.inc");
+?>
diff --git a/WebKitSite/quality/testing.html b/WebKitSite/quality/testing.html
index 6040a9e..def62b0 100644
--- a/WebKitSite/quality/testing.html
+++ b/WebKitSite/quality/testing.html
@@ -6,9 +6,9 @@
<h3>The WebKit Tests</h3>
-<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>
-<p class="code">WebKitTools/Scripts/run-webkit-tests</p>
-<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>
+<p>Before patches can land in any of the frameworks in the repository, the
+layout regression tests must pass. To run these tests, execute the
+<tt>run-webkit-tests</tt> <a href="/coding/scripts.html">script</a>.</p>
<p>The script will dump the render trees for all of the pages and diff the results against the expected correct results. If no
differences are found, then the patch has passed the tests. If any tests fail, then the patch cannot be committed until the
@@ -60,9 +60,9 @@ This is the Mozilla JavaScript test suite.</p>
<h3>How to run the tests</h3>
-<p>Execute the "run-javascriptcore-tests" script:</p>
-<p class="code">WebKitTools/Scripts/run-javascriptcore-tests</p>
-<p>The script will run all the tests and summarize how the results differ from what is currently expected.</p>
+<p>Execute the <tt>run-javascriptcore-tests</tt> <a href="/coding/scripts.html">script</a>.
+The script will run all the tests and summarize how the results differ
+from what is currently expected.</p>
<h3>What just happened</h3>
<p>
@@ -80,7 +80,8 @@ If you fixed a bug that caused an existing failure, you'll also be made aware of
<h3>What happens if I caused a regression?</h3>
-<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>
+<p>It's not the end of the world. Go back and fix your bug and rerun
+<tt>run-javascriptcore-tests</tt> as many times as necessary.</p>
<?php
include("../footer.inc");
--
WebKit Debian packaging
More information about the Pkg-webkit-commits
mailing list