<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[38824] trunk/WebKitSite</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/38824">38824</a></dd>
<dt>Author</dt> <dd>jchaffraix@webkit.org</dd>
<dt>Date</dt> <dd>2008-11-27 17:43:51 -0800 (Thu, 27 Nov 2008)</dd>
</dl>

<h3>Log Message</h3>
<pre>2008-11-27  Julien Chaffraix  &lt;jchaffraix@webkit.org&gt;

        Reviewed by Eric Seidel.

        Bug 22468: Coding style: config.h should only be included in implementation files, not in header
        https://bugs.webkit.org/show_bug.cgi?id=22468

        Clarified the rules about config.h inclusion and added 2 new examples to illustrate it. Also
        added an explanation about the implementation files.

        * coding/coding-style.html:</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkWebKitSiteChangeLog">trunk/WebKitSite/ChangeLog</a></li>
<li><a href="#trunkWebKitSitecodingcodingstylehtml">trunk/WebKitSite/coding/coding-style.html</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkWebKitSiteChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/WebKitSite/ChangeLog (38823 => 38824)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitSite/ChangeLog        2008-11-28 01:26:18 UTC (rev 38823)
+++ trunk/WebKitSite/ChangeLog        2008-11-28 01:43:51 UTC (rev 38824)
</span><span class="lines">@@ -1,3 +1,15 @@
</span><ins>+2008-11-27  Julien Chaffraix  &lt;jchaffraix@webkit.org&gt;
+
+        Reviewed by Eric Seidel.
+
+        Bug 22468: Coding style: config.h should only be included in implementation files, not in header
+        https://bugs.webkit.org/show_bug.cgi?id=22468
+
+        Clarified the rules about config.h inclusion and added 2 new examples to illustrate it. Also
+        added an explanation about the implementation files.
+
+        * coding/coding-style.html:
+
</ins><span class="cx"> 2008-11-25  Dean Jackson  &lt;dino@apple.com&gt;
</span><span class="cx"> 
</span><span class="cx">         Add a new work-in-progress proposal for pointer-events in
</span></span></pre></div>
<a id="trunkWebKitSitecodingcodingstylehtml"></a>
<div class="modfile"><h4>Modified: trunk/WebKitSite/coding/coding-style.html (38823 => 38824)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitSite/coding/coding-style.html        2008-11-28 01:26:18 UTC (rev 38823)
+++ trunk/WebKitSite/coding/coding-style.html        2008-11-28 01:43:51 UTC (rev 38824)
</span><span class="lines">@@ -69,7 +69,7 @@
</span><span class="cx"> &lt;/pre&gt;
</span><span class="cx"> &lt;/li&gt;
</span><span class="cx"> 
</span><del>-&lt;li&gt;In an implementation file, code inside a namespace should &lt;em&gt;not&lt;/em&gt; be indented.
</del><ins>+&lt;li&gt;In an implementation file (files with the extension .cpp, .c or .mm), code inside a namespace should &lt;em&gt;not&lt;/em&gt; be indented.
</ins><span class="cx"> &lt;h4 class=&quot;right&quot;&gt;Right:&lt;/h4&gt;
</span><span class="cx"> &lt;pre class=&quot;code&quot;&gt;
</span><span class="cx"> // Document.cpp
</span><span class="lines">@@ -598,17 +598,58 @@
</span><span class="cx"> 
</span><span class="cx"> &lt;ol&gt;
</span><span class="cx"> 
</span><del>-&lt;li&gt;All files must #include &quot;config.h&quot; first.
</del><ins>+&lt;li&gt;All implementation files must #include &quot;config.h&quot; first. Header
+files should never include &quot;config.h&quot;.
</ins><span class="cx"> 
</span><del>-&lt;li&gt;All files must #include the primary header second, just after &quot;config.h&quot;.
-So for example, Node.cpp should include Node.h first, before other files.
-This guarantees that each header's completeness is tested, to make sure it
-can be compiled without requiring any other header files be included first.
</del><ins>+&lt;h4 class=&quot;right&quot;&gt;Right:&lt;/h4&gt;
+&lt;pre class=&quot;code&quot;&gt;
+// RenderLayer.h
+#include &quot;Node.h&quot;
+#include &quot;RenderObject.h&quot;
+#include &quot;RenderView.h&quot;
+&lt;/pre&gt;
</ins><span class="cx"> 
</span><ins>+&lt;h4 class=&quot;wrong&quot;&gt;Wrong:&lt;/h4&gt;
+&lt;pre class=&quot;code&quot;&gt;
+// RenderLayer.h
+#include &quot;config.h&quot;
+
+#include &quot;RenderObject.h&quot;
+#include &quot;RenderView.h&quot;
+#include &quot;Node.h&quot;
+&lt;/pre&gt;
+
+&lt;li&gt;All implementation files must #include the primary header second,
+just after &quot;config.h&quot;. So for example, Node.cpp should include Node.h first,
+before other files. This guarantees that each header's completeness is tested.
+This also assures that each header can be compiled without requiring any other
+header files be included first.
+
</ins><span class="cx"> &lt;li&gt;Other #include statements should be in sorted order (case sensitive, as
</span><span class="cx"> done by the command-line sort tool or the Xcode sort selection command).
</span><span class="cx"> Don't bother to organize them in a logical order.
</span><span class="cx"> 
</span><ins>+&lt;h4 class=&quot;right&quot;&gt;Right:&lt;/h4&gt;
+&lt;pre class=&quot;code&quot;&gt;
+// HTMLDivElement.cpp
+#include &quot;config.h&quot;
+#include &quot;HTMLDivElement.h&quot;
+
+#include &quot;Attribute.h&quot;
+#include &quot;HTMLElement.h&quot;
+#include &quot;QualifiedName.h&quot;
+
+&lt;/pre&gt;
+
+&lt;h4 class=&quot;wrong&quot;&gt;Wrong:&lt;/h4&gt;
+&lt;pre class=&quot;code&quot;&gt;
+// HTMLDivElement.cpp
+#include &quot;HTMLElement.h&quot;
+#include &quot;HTMLDivElement.h&quot;
+#include &quot;QualifiedName.h&quot;
+#include &quot;Attribute.h&quot;
+&lt;/pre&gt;
+
</ins><span class="cx"> &lt;/ol&gt;
</span><span class="cx"> 
</span><span class="cx"> &lt;?php
</span></span></pre>
</div>
</div>

</body>
</html>