dockerized clang-format error detection tool

2024-09-17 13:52:01 +02:00
parent 469d58f989
commit 771d11a148
4 changed files with 48 additions and 0 deletions
@@ -0,0 +1,26 @@
+# Overview
+
+Dockerized tool to list clang-format errors introduced in a branch.
+
+# Usage
+
+Checkout the branch you want to compare. This is necessary because if there are files added by the branch
+they need to be present for clang-format to analyze them.
+
+Then:
+
+```
+./tools/formatting/detect_clang_format_errors.sh
+```
+
+Or
+
+```
+docker compose up
+```
+
+Or (to avoid docker related lines in stdout)
+
+```
+docker compose run clang-formatter | tee output
+```