doc: how to run clang-format with meson

JeffersonLab · Feb 10, 2024 · 0630bb9 · 0630bb9
1 parent 0f9acd4
commit 0630bb9
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/doc/maintenance.md b/doc/maintenance.md
@@ -24,3 +24,14 @@ Keep the Python binding dependency versions reasonably up to date in the corresp
 We currently support up to the C++ standard defined in:
 - [`meson.build`](../meson.build)
 - example build configurations in [`examples/build_with_*` subdirectories](../examples)
+
+## Auto-Formatting
+
+### C++
+
+We provide a [`.clang-format`](../.clang-format) file for auto-formatting C++ code. If your system has `clang-format`,
+then `meson` will create a `ninja` build target called `clang-format`, which you may run as
+```bash
+ninja -C <builddir> clang-format
+```
+This is useful to do periodically (**TODO**: automate it).