build,github: add a step to check include style #2592
Closed
+72
−0
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
tchaikov
force-pushed
the
check-include-style
branch
from
ad6be0f to
6381640
Compare
In C++, the `#include` preprocessor directive is used to include header files. the path of the header files can be quoted using doube quotes (`"`), and angle brackets (`<>`). Seastar headers should be considered system headers. So we always enforces the policy to include Seastar headers using angle brackets. But sometimes, LSP clients automatically inserts headers to source file if the used symbols are not found by the source file yet. This is handy to developers using the LSP clients, but this could be annoying if the added `#include` directive uses double quotes to include Seastar headers. This happens when clangd is used as the LSP server, as Seastar includes its own headers using `-I` instead of `-isystem`. We prefer the former, because the C++ compiler prints warnings from the header files if they are included using `-I`, this enables the compiler to report potential issues in Seastar's headers. To identify issues like `#include "seastar/core/reactor.hh"`, in this change, a new CMake target named "check-include-style" is added. This target checks the Seastar source files for this issue, and fails the build of the target if this issue is identified. Instead of implementing the check in CMake, a dedicate Python script is used, this allows developers which are not familiar with CMake to audit and improve this script. Signed-off-by: Kefu Chai <[email protected]>
Previously, we do not enforce the policy of including Seastar headers using angle brackets instead of double quotes in our github workflow. In this change, a new step is added to build "check-include-style" target when building the Dev mode. This allows our CI to fail if the tree being tested violates this policy. Signed-off-by: Kefu Chai <[email protected]>
tchaikov
force-pushed
the
check-include-style
branch
from
6381640 to
f0e9187
Compare
tchaikov
commented
Dec 23, 2024
| function (seastar_check_include_style target library) | ||
| get_target_property (sources ${library} SOURCES) | ||
| set (check-target "${target}-${library}") | ||
| message("${sources}") |
There was a problem hiding this comment.
please remove this message, which was added for debugging.
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.
Previously, we do not enforce the policy of including Seastar headers using angle brackets instead of double quotes in our github workflow. In this change, a new step is added to check include style when building the Dev mode. This allows our CI to fail if a change violates this policy.