mirror of
https://github.com/fish-shell/fish-shell
synced 2024-11-13 16:37:34 +00:00
improve linting tool
I found that after fixing the args to `cppcheck` it started reporting lots of varFuncNullUB warnings. Suppress them as they should be safe to ignore. Also, improve the readability of the script.
This commit is contained in:
parent
043725cdd5
commit
8645aa94c8
3 changed files with 32 additions and 9 deletions
5
.cppcheck.suppressions
Normal file
5
.cppcheck.suppressions
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
// suppress all instances of varFuncNullUB: "Passing NULL after the last typed
|
||||||
|
// argument to a variadic function leads to undefined behaviour." That's
|
||||||
|
// because all the places we do this are valid and won't cause problems even
|
||||||
|
// on a ILP64 platform because we're careful about using NULL rather than 0.
|
||||||
|
varFuncNullUB
|
|
@ -35,15 +35,13 @@ for arg in $argv
|
||||||
set cppcheck_args $cppcheck_args $arg
|
set cppcheck_args $cppcheck_args $arg
|
||||||
else if string match -q -- '-I*' $arg
|
else if string match -q -- '-I*' $arg
|
||||||
set cppcheck_args $cppcheck_args $arg
|
set cppcheck_args $cppcheck_args $arg
|
||||||
else if string match -q -- '-iquote*' $arg
|
|
||||||
set cppcheck_args $cppcheck_args $arg
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Not sure when this became necessary but without these flags cppcheck no longer works on macOS.
|
# Not sure when this became necessary but without these flags cppcheck no longer works on macOS.
|
||||||
# It complains that "Cppcheck cannot find all the include files." Adding these include paths should
|
# It complains that "Cppcheck cannot find all the include files." It appears that cppcheck used
|
||||||
# be harmless everyelse.
|
# to, but no longer, recognizes the -iquote flag. So switch to hardcoding the appropriate -I flags.
|
||||||
set cppcheck_args $cppcheck_args -I/usr/include -I.
|
set cppcheck_args $cppcheck_args -I . -I ./src
|
||||||
|
|
||||||
if test "$machine_type" = "x86_64"
|
if test "$machine_type" = "x86_64"
|
||||||
set cppcheck_args -D__x86_64__ -D__LP64__ $cppcheck_args
|
set cppcheck_args -D__x86_64__ -D__LP64__ $cppcheck_args
|
||||||
|
@ -55,7 +53,8 @@ else
|
||||||
# We haven't been asked to lint all the source. If there are uncommitted
|
# We haven't been asked to lint all the source. If there are uncommitted
|
||||||
# changes lint those, else lint the files in the most recent commit.
|
# changes lint those, else lint the files in the most recent commit.
|
||||||
# Select (cached files) (modified but not cached, and untracked files)
|
# Select (cached files) (modified but not cached, and untracked files)
|
||||||
set files (git diff-index --cached HEAD --name-only) (git ls-files --exclude-standard --others --modified)
|
set files (git diff-index --cached HEAD --name-only)
|
||||||
|
set files $files (git ls-files --exclude-standard --others --modified)
|
||||||
if not set -q files[1]
|
if not set -q files[1]
|
||||||
# No pending changes so lint the files in the most recent commit.
|
# No pending changes so lint the files in the most recent commit.
|
||||||
set files (git diff-tree --no-commit-id --name-only -r HEAD)
|
set files (git diff-tree --no-commit-id --name-only -r HEAD)
|
||||||
|
@ -81,9 +80,12 @@ if set -q c_files[1]
|
||||||
for c_file in $c_files
|
for c_file in $c_files
|
||||||
switch $kernel_name
|
switch $kernel_name
|
||||||
case Darwin
|
case Darwin
|
||||||
include-what-you-use -Xiwyu --no_default_mappings -Xiwyu --mapping_file=build_tools/iwyu.osx.imp $cppcheck_args --std=c++11 $c_file 2>&1
|
include-what-you-use -Xiwyu --no_default_mappings -Xiwyu \
|
||||||
|
--mapping_file=build_tools/iwyu.osx.imp --std=c++11 \
|
||||||
|
$cppcheck_args $c_file 2>&1
|
||||||
case Linux
|
case Linux
|
||||||
include-what-you-use -Xiwyu --mapping_file=build_tools/iwyu.linux.imp $cppcheck_args $c_file 2>&1
|
include-what-you-use -Xiwyu --mapping_file=build_tools/iwyu.linux.imp \
|
||||||
|
$cppcheck_args $c_file 2>&1
|
||||||
case '*' # hope for the best
|
case '*' # hope for the best
|
||||||
include-what-you-use $cppcheck_args $c_file 2>&1
|
include-what-you-use $cppcheck_args $c_file 2>&1
|
||||||
end
|
end
|
||||||
|
@ -98,7 +100,23 @@ if set -q c_files[1]
|
||||||
# The stderr to stdout redirection is because cppcheck, incorrectly IMHO, writes its
|
# The stderr to stdout redirection is because cppcheck, incorrectly IMHO, writes its
|
||||||
# diagnostic messages to stderr. Anyone running this who wants to capture its output will
|
# diagnostic messages to stderr. Anyone running this who wants to capture its output will
|
||||||
# expect those messages to be written to stdout.
|
# expect those messages to be written to stdout.
|
||||||
cppcheck -q --verbose --std=posix --language=c++ --template \[(set_color --bold)(set_color --underline)"{file}"(set_color normal)(set_color --bold)":{line}"(set_color normal)"] "(set_color brmagenta)"{severity}"(set_color magenta)" ({id}):"\n(set_color normal)" {message}" --suppress=missingIncludeSystem --inline-suppr --enable=$cppchecks --rule-file=.cppcheck.rule $cppcheck_args $c_files 2>&1
|
set -l cn (set_color normal)
|
||||||
|
set -l cb (set_color --bold)
|
||||||
|
set -l cu (set_color --underline)
|
||||||
|
set -l cm (set_color magenta)
|
||||||
|
set -l cbrm (set_color brmagenta)
|
||||||
|
set -l template "[$cb$cu{file}$cn$cb:{line}$cn] $cbrm{severity}$cm ({id}):$cn\n {message}"
|
||||||
|
set cppcheck_args -q --verbose --std=posix --language=c++ --template $template \
|
||||||
|
--suppress=missingIncludeSystem --inline-suppr --enable=$cppchecks \
|
||||||
|
--rule-file=.cppcheck.rules --suppressions-list=.cppcheck.suppressions $cppcheck_args
|
||||||
|
|
||||||
|
cppcheck $cppcheck_args $c_files 2>&1
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo ========================================
|
||||||
|
echo "Running `cppcheck --check-config` to identify missing includes similar problems"
|
||||||
|
echo ========================================
|
||||||
|
cppcheck $cppcheck_args --check-config $c_files 2>&1
|
||||||
end
|
end
|
||||||
|
|
||||||
if type -q oclint
|
if type -q oclint
|
||||||
|
|
Loading…
Reference in a new issue