Changeset 51587 in webkit

Timestamp:

Dec 1, 2009 9:51:15 PM (14 years ago)

Author:

eric@webkit.org

Message:

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

Reviewed by Darin Adler.

Added clarifications to the web site regarding coding style and
code cleanup--

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

Changes include the following:

• Expanded the style guidelines regarding "using" statements.
• Made the style guidelines page validate as HTML.
• Added that legacy WebKit components should not be cleaned up.
• Added that it is more acceptable to update style when already touching code.

• coding/coding-style.html:
• coding/contributing.html:
• projects/cleanup/index.html:

Location:

trunk/WebKitSite

Files:

• ChangeLog (modified) (1 diff)
• coding/coding-style.html (modified) (3 diffs)
• coding/contributing.html (modified) (1 diff)
• projects/cleanup/index.html (modified) (1 diff)

trunk/WebKitSite/ChangeLog

@@ +1 @@
+2009-12-01  Chris Jerdonek  <chris.jerdonek@gmail.com>
+
+        Reviewed by Darin Adler.
+
+        Added clarifications to the web site regarding coding style and
+        code cleanup--
+
+        https://bugs.webkit.org/show_bug.cgi?id=31618
+
+        Changes include the following:
+
+        - Expanded the style guidelines regarding "using" statements.
+        - Made the style guidelines page validate as HTML.
+        - Added that legacy WebKit components should not be cleaned up.
+        - Added that it is more acceptable to update style when already
+          touching code.
+
+        * coding/coding-style.html:
+        * coding/contributing.html:
+        * projects/cleanup/index.html:
+
 2009-11-18  Eric Seidel  <eric@webkit.org>
 

trunk/WebKitSite/coding/coding-style.html

@@ -1 +1 @@
 <?php 
     $title="WebKit Coding Style Guidelines";
-    include("../header.inc"); 
-?>
-
+    
+    $extra_head_content = <<<END
 <style type="text/css">
 pre .code {
@@ -18 +17 @@
 </style>
 
+
+END;
+
+    include("../header.inc"); 
+?>
 
 <h2>WebKit Coding Style Guidelines</h2>
@@ -702 +706 @@
 </ol>
 
-<h3>"using namespace" Statements</h3>
+<h3>"using" Statements</h3>
 
 <ol>
 
-<li>Do not use "using namespace" statements in header files.
+<li>In header files, do not use "using" statements in global or 
+"namespace" scope.
+
+<h4 class="right">Right:</h4>
+<pre class="code">
+// wtf/Vector.h
+
+namespace WTF {
+
+class VectorBuffer {
+    using std::min;
+    ...
+};
+
+} // namespace WTF
+</pre>
+<h4 class="wrong">Wrong:</h4>
+<pre class="code">
+// wtf/Vector.h
+
+namespace WTF {
+
+using std::min;
+    
+class VectorBuffer {
+    ...
+};
+
+} // namespace WTF
+</pre>
+</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 
+the WTF namespace into the global scope.
+
+<h4 class="right">Right:</h4>
+<pre class="code">
+// wtf/Vector.h
+
+namespace WTF {
+
+} // namespace WTF
+
+using WTF::Vector;
+</pre>
+<h4 class="wrong">Wrong:</h4>
+<pre class="code">
+// wtf/Vector.h
+
+namespace WTF {
+
+} // namespace WTF
+
+using namespace WTF;
+</pre>
+<h4 class="wrong">Wrong:</h4>
+<pre class="code">
+// runtime/UString.h
+
+namespace WTF {
+
+} // namespace WTF
+
+using WTF::PlacementNewAdopt;
+</pre>
 </li>
 

trunk/WebKitSite/coding/contributing.html

@@ -21 +21 @@
 
 <h3>Code Style Guidelines</h3>
-<p>In order for your patch to be landed, it's necessary that it comply to the <a href="/coding/coding-style.html">code style guidelines</a>.
-There are some older parts of the codebase that do not always follow these guidelines. If you come across code like this,
-it's generally best to clean it up to comply with the new guidelines.</p>
+<p>Patches must comply with the <a href="/coding/coding-style.html">code style guidelines</a>.
+Some older parts of the codebase do not follow these guidelines.
+If you are modifying such code, it is generally best to clean it up
+to comply with the current guidelines. An exception is legacy components,
+which should not be cleaned up.</p>
 
 <h3>Regression tests</h3>

trunk/WebKitSite/projects/cleanup/index.html

@@ -17 +17 @@
 <dt>Follow the Coding Style Guidelines</dt>
 <dd>We welcome patches that clean up code to follow our coding style guidelines.
+We especially encourage contributors to clean up code that they are already
+working on. It is less common for contributors to update style without
+making substantive changes. If you would like to clean up code without
+making substantive changes, you are advised to check with project members
+first.</dd>
 
 <dt>Eliminate Redundant Code in WebKit and WebCore</dt>