Document how to build and run the custom clang-tidy checks on Windows #35455
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
SUMMARY: Build "Document how to build and run the custom clang-tidy checks on Windows"
Purpose of change
Document how to build and run the custom clang-tidy checks on Windows, which is nowhere near straightfoward because clang, CMake, and python hate Windows.
Describe the solution
Mostly documentation.
io.h
was renamed tocata_io.h
, because clang-tidy for some reason thinks it should include CDDA'sio.h
when it actually should include the systemio.h
header, causing compilation errors inchkjson.cpp
. A python script was also added to fix errors incompile_commands.json
generated by CMake and used by clang-tidy.Describe alternatives you've considered
Wait until clang, CMake, and python hate Windows less and push a less hacky solution.