[cmd] Remove --tidy-config flag #3822
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
bruntib
added
CLI 💻
|
I agree, though maybe it'd be more user friendly if we would depracate this flag first. |
bruntib
force-pushed
the
remove_tidy_config
branch
from
d436ca0
to
93c9244
Compare
Szelethus
requested changes
Jan 20, 2023
There was a problem hiding this comment.
In my view, this is the worst way to depracate a feature. You are removing the functionality behind the flag, but not the flag itself, leaving those that don't read warning messages (imagine multi-thousand line CI jobs, or integrated environments like vscode) to think that their configuration works, but it doesn't.
Mind that tidy configs are usually low-impact: its easy to not notice that the feature is off.
You should either
- Remove the flag altogether;
- Keep the functionality, but warn that its been deprecated and will be removed in an upcoming release.
bruntib
force-pushed
the
remove_tidy_config
branch
from
93c9244
to
1f5dec8
Compare
|
Alright, I restored the flag's functionality. It will be removed in the next release. |
Szelethus
reviewed
Jan 31, 2023
| @@ -133,8 +133,7 @@ def get_checker_list(self, config) -> Tuple[List[str], List[str]]: | |||
| Return a list of checkers and warnings what needs to be enabled during | |||
| analysis. | |||
|
|
|||
| If the file specified by the '--tidy-config' option contains a 'Checks' | |||
| key or the 'Checks' option is specified through the '--analyzer-config' | |||
| If 'Checks' option is specified through the '--analyzer-config' | |||
There was a problem hiding this comment.
Suggested change
| If 'Checks' option is specified through the '--analyzer-config' | |
| If 'Checks' option is specified through '--analyzer-config' |
CodeChecker analyze --tidy-config is a rarely used and redundant flag. ClangTidy options can be given through .clang-tidy file, --analyzer-config, --checker-config and --tidyargs flags.
bruntib
force-pushed
the
remove_tidy_config
branch
from
1f5dec8
to
be79c68
Compare
Szelethus
approved these changes
Feb 3, 2023
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.
CodeChecker analyze --tidy-config is a rarely used and redundant flag. ClangTidy options can be given through .clang-tidy file, --analyzer-config, --checker-config and --tidyargs flags.