Bug 198349 – check-webkit-style reports false-positive build/include_order warning in WTF C++ source files

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[David Kilzer (:ddkilzer)]

check-webkit-style reports false-positive build/include_order warning in WTF C++ source files.

For example, see Bug 198346 Comment #3:  <https://bugs.webkit.org/show_bug.cgi?id=198346#c3>

ERROR: Source/WTF/wtf/CrossThreadTaskHandler.cpp:29:  Alphabetical sorting problem.  [build/include_order] [4]

For this source in Source/WTF/wtf/CrossThreadTaskHandler.cpp:

    #include "config.h"
    #include <wtf/CrossThreadTaskHandler.h>
    
    #include <wtf/AutodrainedPool.h>

For whatever reason, most C++ source files in WTF use <wtf/Header.h> instead of "Header.h".

[David Kilzer (:ddkilzer)]

This fix cuts down on a HUGE amount of false-positives about a missing primary header when running this command:

$ ./Tools/Scripts/check-webkit-style --filter=-,+build/include_order Source/WTF 2>&1 | grep -i primary

[David Kilzer (:ddkilzer)]

Created attachment 370883 [details]
Patch v1

[Alex Christensen]

Comment on attachment 370883 [details]
Patch v1

r=me
This is necessary so that #pragma once can work with WTF headers, which would otherwise sometimes be included from the build directory and sometimes from the source causing duplicate declarations from including two copies of the same header.

[David Kilzer (:ddkilzer)]

(In reply to Alex Christensen from comment #3)
> Comment on attachment 370883 [details]
> Patch v1
> 
> r=me
> This is necessary so that #pragma once can work with WTF headers, which
> would otherwise sometimes be included from the build directory and sometimes
> from the source causing duplicate declarations from including two copies of
> the same header.

Thanks for the explanation!

[WebKit Commit Bot]

Comment on attachment 370883 [details]
Patch v1

Clearing flags on attachment: 370883

Committed r245870: <https://trac.webkit.org/changeset/245870>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.

[Radar WebKit Bug Importer]

<rdar://problem/51238831>