walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
cppcheck/clang-tidy.md

186 lines
6.3 KiB
Markdown
Raw Normal View History

disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
# clang-tidy
Below are the reasoning why certain checks are (currently) disabled for out code base
## Externals
We do not perform static analysis of the source of the external libraries. `simplecpp` has its own CI with a clang-tidy workflow.
## Disabled Checks
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`abseil-*`<br/>
`altera-*`<br/>
`android-*`<br/>
`boost-*`<br/>
`darwin-*`<br/>
`fuchsia-*`<br/>
`linuxkernel-*`<br/>
`llvm-*`<br/>
`llvmlibc-*`<br/>
`mpi-*`<br/>
`objc-*`<br/>
`openmp-*`<br/>
`zircon-*`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
These are disabled since the platforms/libraries in question are not targeted by us.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`cert-*`<br/>
`cppcoreguidelines-*`<br/>
`google-*`<br/>
`hicpp-*`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
These are coding guidelines we do not follow. Some of the checks might be explicitly enabled though.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-braces-around-statements`<br/>
`readability-isolate-declaration`<br/>
`modernize-use-trailing-return-type`<br/>
`modernize-use-auto`<br/>
`readability-uppercase-literal-suffix`<br/>
`readability-else-after-return`<br/>
`readability-identifier-length`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Use in-class initializers, default constructors, class -> struct (#4842)
2023-08-08 11:05:02 +02:00
These do not reflect the style we are (currently) enforcing.
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-function-size`<br/>
`readability-function-cognitive-complexity`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Use in-class initializers, default constructors, class -> struct (#4842)
2023-08-08 11:05:02 +02:00
We are not interested in the size/complexity of a function.
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-magic-numbers`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Typos fix (#4509)
2022-09-27 06:48:06 +02:00
These do not (always) increase readability.
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`bugprone-macro-parentheses`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
To be documented.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-implicit-bool-conversion`<br/>
updated CI to Clang 16 (#4641)
2023-02-15 19:46:13 +01:00
Use in-class initializers, default constructors, class -> struct (#4842)
2023-08-08 11:05:02 +02:00
This does not appear to be useful as it is reported on very common code.
updated CI to Clang 16 (#4641)
2023-02-15 19:46:13 +01:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`bugprone-narrowing-conversions`<br/>
`performance-no-automatic-move`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
It was decided not to apply these.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`modernize-loop-convert`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
These might change the behavior of code which might not be intended (need to file an upstream issue)
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`modernize-raw-string-literal`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
This leads to a mismatch of raw string literals and regular ones and does reduce the readability.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-convert-member-functions-to-static`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Typos fix (#4509)
2022-09-27 06:48:06 +02:00
Disabled because of false positives with Qt `slot` methods (see https://github.com/llvm/llvm-project/issues/57520).
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`-clang-analyzer-*`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 16 (#4641)
2023-02-15 19:46:13 +01:00
Disabled because of false positives (needs to file an upstream bug report).
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`misc-non-private-member-variables-in-classes`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 16 (#4641)
2023-02-15 19:46:13 +01:00
We intentionally use this.
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`misc-no-recursion`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Leads to lots of "false positives". This seem to enforce a coding guidelines of certain codebases.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`bugprone-easily-swappable-parameters`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
This produces a lot of noise and they are not fixable that easily.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-container-data-pointer`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Disable because of false positives and inconsistent warnings (need to file an upstream bug report).
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`misc-const-correctness`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Work in progress.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`bugprone-assignment-in-if-condition`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Is reported for valid patterns we are using.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-suspicious-call-argument`<br/>
mitigated and enabled more clang-tidy warnings (#4470) * fixed some `performance-inefficient-string-concatenation` clang-tidy warnings * fixed and enabled `modernize-replace-random-shuffle` clang-tidy warning * fixed and enabled `bugprone-suspicious-string-compare` clang-tidy warning * mitigated and enabled `readability-non-const-parameter` clang-tidy warnings * clang-tidy.md: documented some disabled checks * mitigated and enabled `performance-unnecessary-value-param` clang-tidy warnings
2022-09-16 18:58:59 +02:00
Produces a lot of false positives since it is too vague in its analysis.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`performance-inefficient-string-concatenation`<br/>
mitigated and enabled more clang-tidy warnings (#4470) * fixed some `performance-inefficient-string-concatenation` clang-tidy warnings * fixed and enabled `modernize-replace-random-shuffle` clang-tidy warning * fixed and enabled `bugprone-suspicious-string-compare` clang-tidy warning * mitigated and enabled `readability-non-const-parameter` clang-tidy warnings * clang-tidy.md: documented some disabled checks * mitigated and enabled `performance-unnecessary-value-param` clang-tidy warnings
2022-09-16 18:58:59 +02:00
updated CI to Clang 16 (#4641)
2023-02-15 19:46:13 +01:00
Produces warnings which might be considered false positives starting with C++11 - see https://github.com/llvm/llvm-project/issues/54526.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-redundant-access-specifiers`<br/>
updated CI to Clang 16 (#4641)
2023-02-15 19:46:13 +01:00
Reports warning with the Qt `<access-specifier> slots:` syntax in class declarations - see https://github.com/llvm/llvm-project/issues/60055.
mitigated and enabled more clang-tidy warnings (#4470) * fixed some `performance-inefficient-string-concatenation` clang-tidy warnings * fixed and enabled `modernize-replace-random-shuffle` clang-tidy warning * fixed and enabled `bugprone-suspicious-string-compare` clang-tidy warning * mitigated and enabled `readability-non-const-parameter` clang-tidy warnings * clang-tidy.md: documented some disabled checks * mitigated and enabled `performance-unnecessary-value-param` clang-tidy warnings
2022-09-16 18:58:59 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`modernize-avoid-c-arrays`<br/>
updated CI to Clang 16 (#4641)
2023-02-15 19:46:13 +01:00
Produces warnings when `const char[]` is being used which is quite common in our code. Does not make sense to enable before C++17 when `std::string_view` becomes available.
Also reports a false positive about templates which deduce the array length: https://github.com/llvm/llvm-project/issues/60053.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`misc-include-cleaner`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
We run this separately via `clang-include-cleaner` in the `iwyu.yml` workflow as the findings of the include checkers still need to be reviewed manually before applying them.
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`bugprone-branch-clone`<br/>
`readability-const-return-type`<br/>
`modernize-return-braced-init-list`<br/>
`misc-throw-by-value-catch-by-reference`<br/>
`readability-avoid-const-params-in-decls`<br/>
`bugprone-signed-char-misuse`<br/>
`readability-redundant-access-specifiers`<br/>
`concurrency-mt-unsafe`<br/>
`misc-use-anonymous-namespace`<br/>
`performance-avoid-endl`<br/>
`performance-noexcept-swap`<br/>
`bugprone-switch-missing-default-case`<br/>
`bugprone-empty-catch`<br/>
To be evaluated (need to remove exclusion).
`cppcoreguidelines-missing-std-forward`<br/>
`cppcoreguidelines-avoid-const-or-ref-data-members`<br/>
enabled `readability-use-anyofallof` clang-tidy warning / added more checks to evaluate (#5339)
2023-08-31 09:04:51 +02:00
`cppcoreguidelines-macro-usage`<br/>
`cppcoreguidelines-pro-type-member-init`<br/>
`cppcoreguidelines-pro-type-static-cast-downcast`<br/>
`cppcoreguidelines-prefer-member-initializer`<br/>
`cppcoreguidelines-misleading-capture-default-by-value`<br/>
`bugprone-argument-comment.CommentBoolLiterals`<br/>
`cert-err33-c`<br/>
`google-readability-namespace-comments`<br/>
`cppcoreguidelines-special-member-functions`<br/>
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
To be evaluated (need to enable explicitly).
fixed #12042 - deprecated building with Qt5 / build with Qt6 in CI / updated latest Qt in CI to 6.5.3 (#4957) Qt 5.15 will be EOL on May 26 so we should start switching away from it. We already have issues with many of the previous versions and qmake on legacy distros so we should cut that off. I will add a Qt6 release build for Windows in another PR so it can be tested. We should switch to it as the delivered build after the next release and stop using Qt5 altogether in the CI in the release afterwards (that would get rid of several build steps). We could leave it so you could still try to build it but no longer support it so it is up to the user to get it to work before removing it completely later on.
2023-10-26 14:55:59 +02:00
`modernize-type-traits`</br>
`modernize-use-nodiscard`</br>
These apply to codebases which use later standards then C++11 (C++17 is used when building with Qt6) so we cannot simply apply them.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`portability-std-allocator-const`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Only necessary for code which is exclusively compiled with `libc++`. Also disabled for performance reasons - see https://github.com/llvm/llvm-project/issues/57527#issuecomment-1237935132.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`modernize-deprecated-ios-base-aliases`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Warns about aliases which are removed in C++20. Also disabled for performance reasons - see https://github.com/llvm/llvm-project/issues/57527#issuecomment-1237935132.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`bugprone-unchecked-optional-access`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
We are not using any `optional` implementation. Also disabled for performance reasons - see https://github.com/llvm/llvm-project/issues/57527#issuecomment-1237935132.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`modernize-replace-auto-ptr`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
Still available until C++17. It is unlikely such code will ever be introduced. Also disabled for performance reasons - see https://github.com/llvm/llvm-project/issues/57527#issuecomment-1237935132.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`readability-identifier-naming`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
We are currently using our own `naming.json` to enforce naming schemes. Also disabled for performance reasons - see https://github.com/llvm/llvm-project/issues/57527#issuecomment-1237935132.
updated CI to Clang 17 (#4797)
2023-08-09 12:45:15 +02:00
`portability-simd-intrinsics`<br/>
disabled some clang-tidy checks which are not necessary and slow down the analysis / documented disabled checks (#4468) * added `clang-tidy.md` to document our `.clang-tidy` configuration * disabled some clang-tidy checks which are not necessary and slow down the analysis
2022-09-16 07:16:35 +02:00
We are not using SIMD instructions and it suggests to use `std::experiemental::` features which might not be commonly available. Also disabled for performance reasons - see https://github.com/llvm/llvm-project/issues/57527#issuecomment-1237935132.