Lint add warnings instead of check failure #2250
Merged
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
|
It looks like that:
Please remove draft/test: introduce some codding style errors to test new approach when merging this PR, this commit is needed just to illustrate the concept. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Snorch
force-pushed
the
lint-add-warnings-instead-of-check-failure
branch
from
584515d to
557c116
Compare
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## criu-dev #2250 +/- ##
============================================
+ Coverage 70.62% 70.68% +0.06%
============================================
Files 133 133
Lines 33322 33328 +6
============================================
+ Hits 23532 23557 +25
+ Misses 9790 9771 -19
☔ View full report in Codecov by Sentry. |
avagin
reviewed
Aug 24, 2023
rst0git
reviewed
Aug 25, 2023
rst0git
reviewed
Aug 25, 2023
Snorch
force-pushed
the
lint-add-warnings-instead-of-check-failure
branch
2 times, most recently
from
bd2e675 to
09980dc
Compare
|
I've added changes to CONTRIBUTING.md with bad clang-formating examples to PR and a link from warnings to CONTRIBUTING.md, so that it would be easier to understand how this warning should be handled. |
Snorch
force-pushed
the
lint-add-warnings-instead-of-check-failure
branch
4 times, most recently
from
f027924 to
f005eb2
Compare
Snorch
force-pushed
the
lint-add-warnings-instead-of-check-failure
branch
2 times, most recently
from
df89fdb to
69b68e9
Compare
Ctags is mentioned in the beginning of the "Edit the source code" which is really confusing: Do you need ctags to edit CRIU code? - No. It is just one helpful tool to browse the code, and we do not want to enforce it. So, what is it doing in contribution guide? People who really need it should be able to find it in Makefile or just write oneliner of their own to collect tags... Signed-off-by: Pavel Tikhomirov <[email protected]>
This is highlight that code readability is the real goal of all the coding-style rules. We should not do coding-style just for coding-style, e.g. when clang-format suggests crazy formating we should not follow it if we feel it is bad. Signed-off-by: Pavel Tikhomirov <[email protected]>
There are multiple cases where good human readable code block is converted to an unreadable mess by clang-format, so we don't want to rely on clang-format completely. Also there is no way, as far as I can see, to make clang-format only fix what we want it to fix without breaking something. So let's just display hints inline where clang-format is unhappy. When reviewer sees such a warning it's a good sign that something is broken in coding-style around this warning. We add special script which parses diff generated by indent and generates warning for each hunk. Signed-off-by: Pavel Tikhomirov <[email protected]>
Snorch
force-pushed
the
lint-add-warnings-instead-of-check-failure
branch
from
69b68e9 to
1a5d201
Compare
Snorch
force-pushed
the
lint-add-warnings-instead-of-check-failure
branch
from
1a5d201 to
99d878b
Compare
|
I've removed test commit to trigger warnings (it works), so it's now ready to merge. |
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.
There are multiple cases where good human readable code block is
converted to an unreadable mess by clang-format, so we don't want to
rely on clang-format completely. Also there is no way, as far as I can
see, to make clang-format only fix what we want it to fix without
breaking something.
So let's just display hints inline where clang-format is unhappy. When
reviewer sees such a warning it's a good sign that something is broken
in codding style around this warning.