From 8af3584ea8628be12b0be98afb92664dbd0a7f8c Mon Sep 17 00:00:00 2001 From: Michael Richters Date: Wed, 6 Apr 2022 19:03:51 -0500 Subject: [PATCH] Update code style docs with IWYU info Signed-off-by: Michael Richters --- docs/codebase/code-style.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/codebase/code-style.md b/docs/codebase/code-style.md index ca5a4fab..c5fea013 100644 --- a/docs/codebase/code-style.md +++ b/docs/codebase/code-style.md @@ -390,6 +390,10 @@ If a plugin library has symbols meant to be exported, and more than one header f #include "kaleidoscope/plugin/something/Helper.h" ``` +### Automated header includes checking + +We have an automated wrapper for the `include-what-you-use` program from LLVM that processes most Kaleidoscope source files and updates their header includes to comply with the style guide. It requires at least version 0.18 of `include-what-you-use` in order to function properly (because earlier versions do not return a useful exit code, so determining if there was an error was difficult). It can be run by using the `make check-includes` target in the Kaleidoscope Makefile. + ## Scoping