From 0638e38bfc8ef969c7ea9e2005ff051c14dab0f9 Mon Sep 17 00:00:00 2001 From: Xavier Claessens Date: Wed, 10 Mar 2021 08:41:54 -0500 Subject: clangformat: Add clang-format-check target --- docs/markdown/Code-formatting.md | 4 ++-- docs/markdown/snippets/clang-format.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/markdown/Code-formatting.md b/docs/markdown/Code-formatting.md index c8d83de..386c787 100644 --- a/docs/markdown/Code-formatting.md +++ b/docs/markdown/Code-formatting.md @@ -54,5 +54,5 @@ src/*.cpp Note that `.clang-format-ignore` has the same format as used by [`run-clang-format.py`](https://github.com/Sarcasm/run-clang-format). -Modified files will be printed on the console which can be used for example by -CI to ensure all files are correctly formatted. +A new target `clang-format-check` has been added. It returns an error code if +any file needs to be reformatted. This is intended to be used by CI. diff --git a/docs/markdown/snippets/clang-format.md b/docs/markdown/snippets/clang-format.md index 8cb88e0..a390d13 100644 --- a/docs/markdown/snippets/clang-format.md +++ b/docs/markdown/snippets/clang-format.md @@ -39,5 +39,5 @@ Example of `.clang-format-ignore` file: src/*.cpp ``` -Modified files will be printed on the console which can be used for example by -CI to ensure all files are correctly formatted. +A new target `clang-format-check` has been added. It returns an error code if +any file needs to be reformatted. This is intended to be used by CI. -- cgit v1.1