Skip to content

Commit 2e4ca6f

Browse files
Merge pull request #723 from martygrant/martin/update-contrib-build-docs
Update docs for using formatting targets to make it more obvious about helper format-check and format-apply targets
2 parents 02f5d9c + 5ffb713 commit 2e4ca6f

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,11 @@ $ cmake --build build --target format-apply
8989
# Remember to review introduced changes
9090
```
9191

92-
If you wish to use only `clang-format`, or `cmake-format`, or `black`, you can execute the corresponding
93-
`clang-format-check` and `clang-format-apply` for C/C++ source files, or `cmake-format-check` and
94-
`cmake-format-apply` for CMake files, or `black-format-check` and `black-format-apply` for Python
95-
source files, respectively.
92+
**NOTE**: The `format-check` and `format-apply` targets are only available if all of `clang-format`,
93+
`cmake-format` and `black` are installed. Otherwise you can use them separately with:
94+
- `clang-format-check` and `clang-format-apply` for C/C++ source files
95+
- `cmake-format-check` and `cmake-format-apply` for CMake files
96+
- `black-format-check` and `black-format-apply` for Python source files
9697

9798
**NOTE**: We use specific versions of formatting tools to ensure consistency across the project. The required versions are:
9899
- clang-format version **15.0**, which can be installed with the command: `python -m pip install clang-format==15.0.7`.
@@ -220,4 +221,4 @@ $ ctest
220221
$ apt install lcov
221222
$ lcov --capture --directory . --output-file coverage.info
222223
$ genhtml -o html_report coverage.info
223-
```
224+
```

0 commit comments

Comments
 (0)