diff options
| author | Xavier Claessens <xavier.claessens@collabora.com> | 2021-03-10 08:41:54 -0500 |
|---|---|---|
| committer | Xavier Claessens <xclaesse@gmail.com> | 2021-03-16 21:01:54 -0400 |
| commit | 0638e38bfc8ef969c7ea9e2005ff051c14dab0f9 (patch) | |
| tree | 41bb16d587cd02728f2bddd6c31e9a425674d95b /docs | |
| parent | f55868927721f273640a3ba7a8e703d418a352b6 (diff) | |
| download | meson-0638e38bfc8ef969c7ea9e2005ff051c14dab0f9.tar.gz | |
clangformat: Add clang-format-check target
Diffstat (limited to 'docs')
| -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 c8d83dee1..386c78725 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 8cb88e023..a390d13fd 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. |