clang-tidy: fixes and improvements
Fix bigger and smaller kinks in how clang-tidy is configured and used.
Sync behavior more between autotools and cmake, lib/src and tests. Bump
clang-tidy minimum version and prepare logic to allow using clang-tidy
to a fuller extent.
- move clang-tidy settings from builds to a new `.clang-tidy.yml`.
To make it easy to see and edit checks at one place. Also to allow
using the `--checks=` option internally to silence tests-specific
checks. (clang-tidy does not support multiple `--check=` options via
the command-line.)
Use explicit `--config-file=` option to point to the configuration.
- .clang-tidy.yml: link to documentation.
- suppress `clang-diagnostic-nullability-extension` due to a false
positive in libtests with `CURL_WERROR=ON` and `PICKY_COMPILER=OFF`.
- .clang-tidy.yml: enable `portability-*`, `misc-const-correctness`.
- drop `--quiet` clang-tidy option by default to make its working a bit
more transparent. The extra output is minimial.
- consistently use double-dashes in clang-tidy command-line options.
Supported by clang-tidy 9.0.0+ (2019-09-19). Before this patch single
and double were used arbitrarily.
- src/tool_parsecfg: silence false positive `clang-analyzer-unix.Stream`.
Seen with clang 18 + clang-tidy 19 and 20 (only with autotools.)
- INTERNALS: require clang-tidy 14.0.0+. For the `--config-file` option.
- INTERNALS: recommend clang-tidy 19.1.0+, to avoid bogus
`clang-analyzer-valist.Uninitialized` warnings. (bug details below)
autotools:
- allow configuring the clang-tidy tool via `CLANG_TIDY` env.
Also to use in GHA to point to a suffixed clang-tody tool.
- fix to pass CFLAGS to lib, src sources.
(keep omitting them when using a non-clang compiler.)
- fix to pass `--warnings-as-errors=*` in quotes to avoid globbing.
cmake:
- fix to not pass an empty `-I` to clang-tidy.
- fix to pass CFLAGS (picky warnings) to clang-tidy for test sources.
(keep omitting them when using a non-clang compiler.)
- fix to disable `clang-diagnostic-unused-function` for test sources.
(tests have static entry points, which trigger this check when
checking them as individidual sources.)
- fix forwarding `CURL_CLANG_TIDYFLAGS` to clang-tidy.
- force disable picky warnings when running clang-tidy with a non-clang
compiler. To not pass these flags when checking lib and src.
CI:
- GHA/linux: avoid clang-tidy bug by upgrading to v19, and drop the
workaround.
- GHA/linux: switch to clang from gcc in the clang-tidy job. Using gcc
doesn't allow passing CFLAGS to clang-tidy, making it less effective.
(My guess this was one factor contributing to this job often missing
to find certain issues compared to GHA/macos.)
I recomment using clang-tidy with a clang compiler, preferably the same
version or one that's compatible. Other cases are best effort, and may
fail if a C flag is passed to clang-tidy that it does not understand.
Picky warnings are mostly omitted when using a non-clang compiler,
reducing its usefulness.
Details and reproducer for the v18 (and earlier) clang-tidy bug,
previously affecting the GHA/linux job:
clang-tidy <=18 emits false warnings way when passing multiple C sources
at once (as done with autotools):
```sh
cat > src1.c <<EOF
#include <string.h>
static void dummy(void *p) { memcmp(p, p, 0); }
EOF
cat > src2.c <<EOF
#include <stdarg.h>
void vafunc(int option, ...)
{
va_list param;
va_start(param, option);
if(option)
(void)va_arg(param, int);
va_end(param);
}
EOF
/opt/homebrew/opt/llvm@18/bin/clang-tidy --checks=clang-analyzer-valist.Uninitialized src1.c src2.c
# src2.c:7:11: warning: va_arg() is called on an uninitialized va_list [clang-analyzer-valist.Uninitialized]
```
Follow-up to e86542038dda88dadf8959584e803895f979310c #17047
Closes #20605
2026-02-15 23:58:39 +01:00
|
|
|
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
|
|
#
|
|
|
|
|
# SPDX-License-Identifier: curl
|
|
|
|
|
---
|
2026-02-21 00:08:59 +01:00
|
|
|
# https://clang.llvm.org/extra/clang-tidy/
|
clang-tidy: fixes and improvements
Fix bigger and smaller kinks in how clang-tidy is configured and used.
Sync behavior more between autotools and cmake, lib/src and tests. Bump
clang-tidy minimum version and prepare logic to allow using clang-tidy
to a fuller extent.
- move clang-tidy settings from builds to a new `.clang-tidy.yml`.
To make it easy to see and edit checks at one place. Also to allow
using the `--checks=` option internally to silence tests-specific
checks. (clang-tidy does not support multiple `--check=` options via
the command-line.)
Use explicit `--config-file=` option to point to the configuration.
- .clang-tidy.yml: link to documentation.
- suppress `clang-diagnostic-nullability-extension` due to a false
positive in libtests with `CURL_WERROR=ON` and `PICKY_COMPILER=OFF`.
- .clang-tidy.yml: enable `portability-*`, `misc-const-correctness`.
- drop `--quiet` clang-tidy option by default to make its working a bit
more transparent. The extra output is minimial.
- consistently use double-dashes in clang-tidy command-line options.
Supported by clang-tidy 9.0.0+ (2019-09-19). Before this patch single
and double were used arbitrarily.
- src/tool_parsecfg: silence false positive `clang-analyzer-unix.Stream`.
Seen with clang 18 + clang-tidy 19 and 20 (only with autotools.)
- INTERNALS: require clang-tidy 14.0.0+. For the `--config-file` option.
- INTERNALS: recommend clang-tidy 19.1.0+, to avoid bogus
`clang-analyzer-valist.Uninitialized` warnings. (bug details below)
autotools:
- allow configuring the clang-tidy tool via `CLANG_TIDY` env.
Also to use in GHA to point to a suffixed clang-tody tool.
- fix to pass CFLAGS to lib, src sources.
(keep omitting them when using a non-clang compiler.)
- fix to pass `--warnings-as-errors=*` in quotes to avoid globbing.
cmake:
- fix to not pass an empty `-I` to clang-tidy.
- fix to pass CFLAGS (picky warnings) to clang-tidy for test sources.
(keep omitting them when using a non-clang compiler.)
- fix to disable `clang-diagnostic-unused-function` for test sources.
(tests have static entry points, which trigger this check when
checking them as individidual sources.)
- fix forwarding `CURL_CLANG_TIDYFLAGS` to clang-tidy.
- force disable picky warnings when running clang-tidy with a non-clang
compiler. To not pass these flags when checking lib and src.
CI:
- GHA/linux: avoid clang-tidy bug by upgrading to v19, and drop the
workaround.
- GHA/linux: switch to clang from gcc in the clang-tidy job. Using gcc
doesn't allow passing CFLAGS to clang-tidy, making it less effective.
(My guess this was one factor contributing to this job often missing
to find certain issues compared to GHA/macos.)
I recomment using clang-tidy with a clang compiler, preferably the same
version or one that's compatible. Other cases are best effort, and may
fail if a C flag is passed to clang-tidy that it does not understand.
Picky warnings are mostly omitted when using a non-clang compiler,
reducing its usefulness.
Details and reproducer for the v18 (and earlier) clang-tidy bug,
previously affecting the GHA/linux job:
clang-tidy <=18 emits false warnings way when passing multiple C sources
at once (as done with autotools):
```sh
cat > src1.c <<EOF
#include <string.h>
static void dummy(void *p) { memcmp(p, p, 0); }
EOF
cat > src2.c <<EOF
#include <stdarg.h>
void vafunc(int option, ...)
{
va_list param;
va_start(param, option);
if(option)
(void)va_arg(param, int);
va_end(param);
}
EOF
/opt/homebrew/opt/llvm@18/bin/clang-tidy --checks=clang-analyzer-valist.Uninitialized src1.c src2.c
# src2.c:7:11: warning: va_arg() is called on an uninitialized va_list [clang-analyzer-valist.Uninitialized]
```
Follow-up to e86542038dda88dadf8959584e803895f979310c #17047
Closes #20605
2026-02-15 23:58:39 +01:00
|
|
|
|
2026-02-21 00:08:59 +01:00
|
|
|
# https://clang.llvm.org/extra/clang-tidy/checks/list.html
|
2026-02-19 15:47:00 +01:00
|
|
|
Checks:
|
2026-03-01 04:03:15 +01:00
|
|
|
- clang-analyzer-*
|
2026-02-19 15:47:00 +01:00
|
|
|
- -clang-analyzer-optin.performance.Padding
|
|
|
|
|
- -clang-analyzer-security.ArrayBound # due to false positives with clang-tidy v21.1.0
|
2026-02-19 16:33:52 +01:00
|
|
|
- -clang-analyzer-security.insecureAPI.bzero # for FD_ZERO() (seen on macOS)
|
2026-02-19 15:47:00 +01:00
|
|
|
- -clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling
|
|
|
|
|
- -clang-diagnostic-nullability-extension
|
2026-02-19 00:16:24 +01:00
|
|
|
- bugprone-assert-side-effect
|
|
|
|
|
- bugprone-chained-comparison
|
|
|
|
|
- bugprone-dynamic-static-initializers
|
2026-02-20 14:20:53 +01:00
|
|
|
- bugprone-macro-parentheses
|
2026-02-19 00:16:24 +01:00
|
|
|
- bugprone-macro-repeated-side-effects
|
|
|
|
|
- bugprone-misplaced-operator-in-strlen-in-alloc
|
|
|
|
|
- bugprone-misplaced-pointer-arithmetic-in-alloc
|
|
|
|
|
- bugprone-not-null-terminated-result
|
|
|
|
|
- bugprone-posix-return
|
2026-02-18 17:43:14 +01:00
|
|
|
- bugprone-redundant-branch-condition
|
2026-02-18 17:39:23 +01:00
|
|
|
- bugprone-signed-char-misuse
|
2026-02-19 00:16:24 +01:00
|
|
|
- bugprone-suspicious-enum-usage
|
|
|
|
|
- bugprone-suspicious-memset-usage
|
|
|
|
|
- bugprone-suspicious-missing-comma
|
2026-02-19 15:47:00 +01:00
|
|
|
- bugprone-suspicious-realloc-usage
|
2026-02-19 00:16:24 +01:00
|
|
|
- bugprone-suspicious-semicolon
|
2026-02-19 15:47:00 +01:00
|
|
|
- misc-const-correctness
|
2026-02-18 15:14:06 +01:00
|
|
|
- misc-header-include-cycle
|
2026-02-19 15:47:00 +01:00
|
|
|
- portability-*
|
lib: use lib source directory as base include path
Backtrack on previous change that aimed to solve the wrong `share.h`
being included. It turns out it did not fix this issue. At the same time
it introduced relative header filenames and the need to include the same
headers differently depending on the source files' location, reducing
readability and editability.
Replace this method by re-adding curl's lib source directory to the
header path and addressing headers by the their full, relative name to
that base directory. Aligning with this method already used in src and
tests.
With these advantages:
- makes includes easier to read, recognize, grep, sort, write, and copy
between sources,
- syncs the way these headers are included across curl components,
- avoids the ambiguity between system `schannel.h`, `rustls.h` vs.
local headers using the same names in `lib/vtls`,
- silences clang-tidy `readability-duplicate-include` checker, which
detects the above issue,
Ref: https://clang.llvm.org/extra/clang-tidy/checks/readability/duplicate-include.html
- possibly silences TIOBE coding standard warnings:
`6.10.2.a: Don't use relative paths in #include statements.`
- long shot: it works well with concatenated test sources, for
clang-tidy-friendly custom unity builds. Ref: #20667
Slight downside: it's not enforced.
If there happens to be a collision between a local `lib/*.h` header and
a system one, the solution is to rename (possibly with its `.c`
counterpart) into the `curl_` namespace. This is also the method used by
curl in the past.
Also:
- curlx/inet_pton: reduce scope of an include.
- toolx/tool_time: apply this to an include, and update VS project
files accordingly. Also dropping unnecessary lib/curlx header path.
- clang-tidy: enable `readability-duplicate-include`.
Follow-up to 3887069c661b40e76b053a4867eb565d4761ab3e #19676
Follow-up to 625f2c1644da58b9617479775badea21f125ce6d #16991 #16949
Closes #20623
2026-02-19 00:44:43 +01:00
|
|
|
- readability-duplicate-include
|
2026-02-23 00:59:57 +01:00
|
|
|
- readability-math-missing-parentheses
|
2026-02-19 15:47:00 +01:00
|
|
|
- readability-named-parameter
|
|
|
|
|
- readability-redundant-control-flow
|
2026-02-19 00:16:24 +01:00
|
|
|
- readability-redundant-declaration
|
|
|
|
|
- readability-redundant-function-ptr-dereference
|
|
|
|
|
- readability-redundant-parentheses
|
2026-02-19 15:47:00 +01:00
|
|
|
- readability-redundant-preprocessor
|
2026-02-18 14:24:00 +01:00
|
|
|
- readability-suspicious-call-argument
|
2026-02-19 15:47:00 +01:00
|
|
|
- readability-uppercase-literal-suffix
|
2026-02-18 15:14:06 +01:00
|
|
|
|
|
|
|
|
CheckOptions:
|
2026-02-25 18:18:02 +01:00
|
|
|
misc-header-include-cycle.IgnoredFilesList: 'curl/curl.h'
|
2026-02-25 15:01:47 +01:00
|
|
|
|
|
|
|
|
HeaderFilterRegex: '.*'
|