Skip to content

Commit d25510f

Browse files
committed
Document the version of clang-format used
Different version of clang-format may format files differently, which would cause CI issues in the linting job if there is a mismatch. This commit documents in the README that version 11 is the one that is used. Fixes: #32
1 parent 06cdb24 commit d25510f

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Make sure you have these programs installed:
7373
* [cppcheck](#cppcheck) (optional)
7474
* [Doxygen](#doxygen) (optional)
7575
* [LCOV](#lcov) (optional)
76-
* [clang-format](#clang-format) (optional)
76+
* [clang-format 11](#clang-format) (optional)
7777
* [codespell](#codespell) (optional)
7878

7979
---
@@ -166,6 +166,9 @@ used to enforce style guides.
166166
Two targets are made available to check and fix code in developer mode using
167167
the `format-check` and `format-fix` targets respectively.
168168

169+
**NOTE**: the project generates files that are formatted according to
170+
clang-format 11. Newer or older versions may format the project differently.
171+
169172
### codespell
170173

171174
[codespell][15] is a tool to find and fix spelling errors mainly in source

0 commit comments

Comments
 (0)