[fix] Resolve checker enable/disable ambiguity #4392
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
cservakt
added
CLI 💻
bruntib
previously requested changes
Dec 2, 2024
cservakt
force-pushed
the
ambigous-checker-options
branch
3 times, most recently
from
ee96319 to
e428702
Compare
dkrupp
requested changes
Dec 3, 2024
There was a problem hiding this comment.
- Please update the help of CodeChecker analyze --help and mention the :checker prefix option
- Update the analyzer user guide https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/user_guide.md#toggling-checkers
and remove any -Wwarning syntax suggestion. Describe the new "checker:" and "prefix:" syntax. Describe the name clash resolution logic
These are the direct remarks. More comments will come soon.
cservakt
force-pushed
the
ambigous-checker-options
branch
from
e428702 to
e6a8c5d
Compare
dkrupp
requested changes
Dec 5, 2024
There was a problem hiding this comment.
Please also fix this section
https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/user_guide.md#toggling-checkers
"
Command line --enable/--disable flags.
Their arguments may start with profile: of guideline: prefix which makes the choice explicit.
Without prefix it means a profile name, a guideline name or a checker group/name in this priority order."
Describe the checker:, prefix: and describe that priority order does not matter, an ambiguity causes error.
- remove all old --enable W* warning enable syntax from
https://github.com/Ericsson/codechecker/blob/master/docs/analyzer/user_guide.md#toggling-compiler-warnings
section
cservakt
force-pushed
the
ambigous-checker-options
branch
3 times, most recently
from
ba26d93 to
eaf043f
Compare
This PR fixes the enabling and disabling checker options, focusing on resolving ambiguities in option processing. Key updates: Ambiguity handling: When ambiguous checker options are provided with `-e` or `-d` flags, an error is now raised. The user receives suggestions for specifying the option by using namespaces (checker, prefix, guideline, etc.). If a checker name matches multiple checkers as a prefix, it triggers an ambiguity error. Suggestions are provided to help users choose between the checker name or the prefix. Additional namespaces: A new `checker` namespace is created. All label types can be a namespace as well, specified with a `:` separator before the checker option. Default profile settings improvements: Only those checkers enabled that has profile:default label in the label files. Prefix-based configuration is no longer applied for the default profile, ensuring precise and predictable behavior. Getting rid of `W` prefix: It is no longer available to enable or disable a warrning with W.
cservakt
force-pushed
the
ambigous-checker-options
branch
from
eaf043f to
fe19dc0
Compare
dkrupp
requested changes
Dec 10, 2024
dkrupp
changed the title
dkrupp
approved these changes
Dec 10, 2024
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.
This PR fixes the enabling and disabling checker options, focusing on resolving ambiguities in option processing.
Key updates:
Ambiguity handling:
Additional namespaces:
Default profile settings improvements:
Getting rid of
Wprefix: