diff options
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Code-formatting.md | 4 | ||||
| -rw-r--r-- | docs/markdown/snippets/clang-format.md | 4 |
2 files changed, 4 insertions, 4 deletions
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. |