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

Implement include-what-you-use policy #63

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

BenBE
Copy link
Contributor

@BenBE BenBE commented Oct 19, 2019

This implements the include-what-you-use policy to clean up cross-references between headers and clearly show what actually is used inside a file. While this is by far not the minimal set of headers allowed to be included, this gives a good and stable set of includes to avoid breakage if something is moved around. Also the tool iwyu allows to detect headers that are included but never used.

This PR includes three patches:

  1. Cleanup of includes in all source and header files
  2. Basic implementation to use IWYU from the Makefile
  3. Some fine-tuning to disable IWYU by default as its output can be quite verbose at times

Note that IWYU uses a fixed clang version. Thus if IWYU is compiled to use a certain clang version you need to provide the proper clang binary and system include files or IWYU will report missing files even though normal compilation succeeds. See the documentation of Include-What-You-Use for details.

@BenBE BenBE force-pushed the include-what-you-use branch 2 times, most recently from 3c561b1 to 12fba1f Compare November 2, 2019 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant