seastar/testing: only include used headers #2413
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
including unused header hurts the readability of source code. and
could potentially slow down the compiling.
these unused headers were identified with clang-include-cleaner
with following process:
1. ./configure.py --disable-dpdk --compiler clang++ \
--compile-commands-json --mode debug
2. find include/seastar/testing -name *.hh \
-exec echo {} \; \
-exec clang-include-cleaner --print=changes -p build/debug {} \;
3. audit all the reported unused headers, check if
they are used or not by inspecting the header
files in the report, and remove the includes which
are not used. add the marks to the one which are
actually used.
the "IWYU" marks are documented at
https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md,
since clang's include-cleaner supports IWYU pragma. they are used
to prevent the false alarms in future.
Signed-off-by: Kefu Chai <[email protected]>
niekbouman
pushed a commit
to niekbouman/seastar
that referenced
this pull request
Sep 16, 2024
including unused header hurts the readability of source code. and
could potentially slow down the compiling.
these unused headers were identified with clang-include-cleaner
with following process:
1. ./configure.py --disable-dpdk --compiler clang++ \
--compile-commands-json --mode debug
2. find include/seastar/testing -name *.hh \
-exec echo {} \; \
-exec clang-include-cleaner --print=changes -p build/debug {} \;
3. audit all the reported unused headers, check if
they are used or not by inspecting the header
files in the report, and remove the includes which
are not used. add the marks to the one which are
actually used.
the "IWYU" marks are documented at
https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md,
since clang's include-cleaner supports IWYU pragma. they are used
to prevent the false alarms in future.
Signed-off-by: Kefu Chai <[email protected]>
Closes scylladb#2413
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
including unused header hurts the readability of source code. and could potentially slow down the compiling.
these unused headers were identified with clang-include-cleaner with following process:
the "IWYU" marks are documented at
https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md, since clang's include-cleaner supports IWYU pragma. they are used to prevent the false alarms in future.