Skip to content

Commit

Permalink
Merge pull request Ericsson#4097 from Szelethus/gcc_limitations_docs
Browse files Browse the repository at this point in the history
[gcc][docs] Elaborote on the configuration a bit more
  • Loading branch information
Szelethus authored Dec 1, 2023
2 parents 6733322 + bdbe876 commit 454bbf0
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions docs/analyzer/checker_and_analyzer_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,21 +268,35 @@ CodeChecker check -l ./compile_commands.json \
-o ./reports
```

# GCC Static Analyzer
# Configuring the GCC Static Analyzer

As of CodeChecker 6.23, Codechecker can now execute the GCC Static Analyzer.
The minimum version of GCC we support is 13.0.0. If you are having trouble with
making CodeChecker find the appropriate binary, try using the `CC_ANALYZER_BIN`
environmental variable (see `CodeChecker analyze --help`).

## Analyzer Configuration

TODO: Currently, we don't support GCC Static analyzer options. This will likely
be fixed in between the 6.23 release candidates and the actual release.
Currently, we don't support configuring the GCC Static analyzer through
CodeChecker. The _overwhelming_ majority of these configurations are only
recommended for developers -- but we will keep an eye out if this ever changes.

TODO: gcc-too-complex
As of now, we are not aware of any configurations for checkers.

## Limitations

TODO: Gcc doesn't well with C++. Prefer only running on C.
Up to and including GCC version 13, the analyzer is only recommended for C
code.

Taint checkers are still in the early phases in development as of GCC-13, so
they should only be enabled for experimentation.

## Example invocation

TODO
``` shell
CodeChecker check -l ./compile_commands.json \
--analyzers gcc \ # Run GCC analyzer only
-e gcc \ # enable all checkers starting with "gcc"
-d gcc-double-free \ # disable gcc-double-free
-o ./reports
```

0 comments on commit 454bbf0

Please sign in to comment.