Add documentation for include sanitization #3048
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds documentation explaining how you can use IWYU or clangd diagnostics to clean up includes. This is the first step in trying to slowly fix #624. The number of include errors we currently have is very high and I don't think it's feasible to fix the entire thing in one go, so I'm proposing to start with making anyone that touches a file in a PR responsible for fixing the includes for that file (This should probably and ideally be enforced by CI). Doing this should slowly make the code cleaner and maybe in the future we can add an IWYU stage to CI.
Note that IWYU can automatically fix includes but I don't think it's a good idea to do something like this automatically.