Bug 22468 - Coding style: config.h should only be included in implementation files, not in header
Summary: Coding style: config.h should only be included in implementation files, not i...
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: Tools / Tests (show other bugs)
Version: 528+ (Nightly build)
Hardware: PC OS X 10.5
: P2 Normal
Assignee: Nobody
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-24 14:51 PST by Julien Chaffraix
Modified: 2008-11-27 17:45 PST (History)
0 users

See Also:


Attachments
Proposed addition: mostly made for discussion & enhancement (2.39 KB, patch)
2008-11-25 16:01 PST, Julien Chaffraix
eric: review-
Details | Formatted Diff | Diff
Updated proposition: add one more example, explains a bit what an implementation file is (3.09 KB, patch)
2008-11-26 14:41 PST, Julien Chaffraix
eric: review+
Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Julien Chaffraix 2008-11-24 14:51:15 PST
See https://bugs.webkit.org/show_bug.cgi?id=22441#c7 for Darin's explanation on that subject.
Comment 1 Julien Chaffraix 2008-11-25 16:01:50 PST
Created attachment 25509 [details]
Proposed addition: mostly made for discussion & enhancement
Comment 2 Eric Seidel (no email) 2008-11-25 17:49:35 PST
Comment on attachment 25509 [details]
Proposed addition: mostly made for discussion & enhancement

I'm not sure it's clear to me from reading what an "implementation" file is.  Maybe (.cpp, .c, .mm, etc.) as an aside would help.

This sentence is backwards:
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.

"This assures that each header can be compiled without requiring any other header included first."  or similar, no need to state "completeness" and then define it.

An extra wrong example of HTMLDivElement.h might be helpful.

Having HTMLDivElement.cpp unsorted might also be useful. :)

Otherwise looks fine.  This is a useful change to the style guide.
Comment 3 Julien Chaffraix 2008-11-26 14:41:54 PST
Created attachment 25540 [details]
Updated proposition: add one more example, explains a bit what an implementation file is
Comment 4 Eric Seidel (no email) 2008-11-26 14:56:56 PST
Comment on attachment 25540 [details]
Updated proposition: add one more example, explains a bit what an implementation file is

Looks good.  Thanks!
Comment 5 Julien Chaffraix 2008-11-27 17:45:13 PST
Landed in r38824.