[clang-tidy] Hackathon coordination issue (#20596) · Issues · ParaView / ParaView

[clang-tidy] Hackathon coordination issue

clang-tidy has a lot of warnings that we're excluding right now. Attached is a build log containing all clang-tidy warnings for the current source tree. To coordinate, there are some tools I recommend using:

I use Vim, so I'll describe my setup. Users of other IDEs/editors can chime in how to set this up in other environments.

Step 1

Download the compile_output.log file containing all warnings.

Step 2

Mock out the compiler to support filtering warnings. I do this via:

set makeprg=make

with this file in my source tree (and compile_output.log beside it).

all:
	grep warning: compile_output.log | sed -e 's,/builds/gitlab-kitware-sciviz-ci/build/../,,'

lints:
	grep warning: compile_output.log | grep -v -e -W | sed -e 's,/builds/gitlab-kitware-sciviz-ci/build/../,,'

%:
	grep warning: compile_output.log | grep -v -e -W | \
		sed -e 's,/builds/gitlab-kitware-sciviz-ci/build/../,,' | \
		sed -e 's,^\.\./,,' | \
		sed -e 's,^\.\./,,' | \
		grep -e "$@"

Step 3

Run :make name-of-lint to act as if the build made the warnings seen in CI. Special targets are :make which outputs all warnings and :make lints to output all clang-tidy lints. Note that any absolute paths that show up are generated files and a code generator may need patched to fix problems. In addition, additional context (such as fixits) may be available in the full log. Note that line numbers do not update, so lint fixes that change line counts are going to need some extra care when fixing multiple things within a single file.

For the main body of ParaView source code, please grab a single lint for each commit and remove it from the .clang-tidy file. In addition to the main ParaView source code, there are a few third-party bits that should be tackled individually:

Plugins/AnalyzeNIfTIReaderWriter/NIfTIIO/ThirdParty
Plugins/CDIReader/Reader/ThirdParty
Plugins/Datamine/Readers/ThirdParty
Plugins/GenericIOReader/Readers/LANL
Plugins/GeodesicMeasurement/Filters/FmmMesh
Utilities/VisItBridge/Library (VisIt code)
Utilities/VisItBridge/databases (VisIt code)
Utilities/VisItBridge/databases/AvtAlgorithms (ParaView code for adapting VisIt readers)
ThirdParty (these use the import mechanism; probably best left for later)

Here is a list of lints that are unmasked. Some are far larger than others, so grab what seems reasonable for a single MR at a time (please check the box to claim the lint to avoid duplicating work). Fixing one lint may make another appear in the changed code; we can fix up such logical conflicts in a followup. Local testing and building is highly recommended because the dashboards aren't going to get through all of these fixes in a day.

Analyzer-based warnings usually require more in-depth investigation, but can point out holes in logic. Fixes for these likely deserve a commit per fix to explain how things are better now.

Edited Mar 24, 2021 by Cory Quammen

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information