build: introduce clang-format in the code base, enforce via CI #4
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
Individual developers should execute "make reformat-code" or equivalent at each commit; they can use a pre-commit hook if they want. The commit also adds a CI workflow that verifies that the tip of a PR (or of main) respects the clang-format rules.
muxator
force-pushed
the
clang-format
branch
3 times, most recently
from
c76e3cf
to
598660a
Compare
muxator
force-pushed
the
clang-format
branch
from
598660a
to
b830226
Compare
muxator
force-pushed
the
clang-format
branch
from
b830226
to
be11084
Compare
muxator
force-pushed
the
clang-format
branch
3 times, most recently
from
c7e46c5
to
e81ea40
Compare
This change has been done individually in order to manually inspect it, as advised by https://clang.llvm.org/docs/ClangFormatStyleOptions.html#insertbraces: Setting this option to true could lead to incorrect code formatting due to clang-format’s lack of complete semantic information. As such, extra care should be taken to review code changes made by this option.
muxator
force-pushed
the
clang-format
branch
from
d186846
to
2694ebc
Compare
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.
Individual developers should execute
make reformat-codeor equivalent at each commit; they can use a pre-commit hook if they want.The commit also adds a CI workflow that verifies that the tip of a PR (or of main) respects the clang-format rules.
The rules are defined in
<BASE>/.clang-formatand (for now) are just a small variation of the default LLVM rules. We can change them before merging.A placeholder has been put in
README.mdto remember us to document this aspect.