Add dockerized include what you use tool

Introduces a tool that organizes C/C++ header includes. The tools output should still be manually reviewed by a contributor.
2024-10-10 09:41:11 +02:00
parent e15fa14c57
commit de4a737131
4 changed files with 69 additions and 1 deletions
@@ -0,0 +1,23 @@
+# Overview
+
+IWYU - [include what you use](https://github.com/include-what-you-use/include-what-you-use)
+is a tool that can detect and correct C/C++ include errors
+
+# Usage
+
+```
+TARGET=<your target> docker compose up
+```
+
+Automatically apply suggestions:
+
+```
+TARGET=<your target> docker compose run iwyu | tee suggestions
+cat suggestions | python3 ~/include-what-you-use/fix_includes.py
+```
+
+Apply only removal suggestions
+
+```
+cat suggestions | grep "should add these line\|The full include-list\|should remove these lines\|^-" | python3 ~/include-what-you-use/fix_includes.py
+```