Repository navigation
Include What You Use #8357
Description
Include What You Use (no more, no less)
References:
- https://google.github.io/styleguide/cppguide.html#Include_What_You_Use
- https://rawgit.com/AliceO2Group/CodingGuidelines/master/coding_guidelines.html#Header_Files
- https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#sf10-avoid-dependencies-on-implicitly-included-names
- https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rs-contained
- https://llvm.org/docs/CodingStandards.html#include-as-little-as-possible
- https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/WhyIWYU.md
Tools:
- https://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html
- https://clang.llvm.org/extra/clang-tidy/checks/llvm/include-order.html
- https://clangd.llvm.org/design/include-cleaner
- https://clangd.llvm.org/guides/include-cleaner
- https://github.com/bkryza/clang-include-graph
Ideas:
- A file which does not include what it uses does not compile. This can be tested with:
(It should be enough to check for non-zero exit code to detect compilation errors.)
clang-tidy <file>
However, if it compiles, it does not mean that all used headers are included directly nor that no unused headers are included. - When the file compiles, the includes in it can be fixed automatically with:
until there are no warnings left.
clang-tidy --fix -checks=-*,misc-include-cleaner <file>
- Once all headers are self-contained, source files can be fixed with the same procedure.
Activity
vkucera commentedon May 23, 2025
vkucera commentedon Jun 6, 2025
vkucera commentedon Jun 11, 2025
vkucera commentedon Jun 19, 2025
6 remaining items
vkucera commentedon Mar 26, 2026
vkucera commentedon Apr 10, 2026
vkucera commentedon Apr 16, 2026
vkucera commentedon Apr 17, 2026
vkucera commentedon Apr 20, 2026
vkucera commentedon May 4, 2026
vkucera commentedon May 27, 2026
vkucera commentedon Jul 13, 2026
Checked with CI:
vkucera commentedon Jul 13, 2026
vkucera commentedon Jul 30, 2026
vkucera commentedon Aug 4, 2026