Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to build and run the custom clang-tidy checks on Windows #35455

Merged
merged 3 commits into from
Dec 8, 2019

Conversation

Qrox
Copy link
Contributor

@Qrox Qrox commented Nov 10, 2019

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 to cata_io.h, because clang-tidy for some reason thinks it should include CDDA's io.h when it actually should include the system io.h header, causing compilation errors in chkjson.cpp. A python script was also added to fix errors in compile_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.

@ifreund ifreund added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs labels Nov 10, 2019
@Qrox Qrox marked this pull request as ready for review December 8, 2019 07:01
@ZhilkinSerg ZhilkinSerg merged commit 6ffa818 into CleverRaven:master Dec 8, 2019
@Qrox Qrox deleted the clang-tidy-doc branch December 14, 2019 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
<Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants