From d486d60e7b28d19e2a2706cd218e4de0d0d60d59 Mon Sep 17 00:00:00 2001 From: rturrado Date: Mon, 25 Nov 2024 15:39:45 +0100 Subject: [PATCH] Update docs. --- docs/dev-guide/dev-guide.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/dev-guide/dev-guide.md b/docs/dev-guide/dev-guide.md index e3ab57a9..7a359598 100644 --- a/docs/dev-guide/dev-guide.md +++ b/docs/dev-guide/dev-guide.md @@ -143,11 +143,12 @@ python3 ./scripts/run_cpp_linters.py . !!! note - The linters require: - - - `clang-format-18` and `clang-tidy-18` to be installed on the system, and - - a build folder containing a `compile_commands.json`. `run_cpp_linters.py` will use `build/Release` as default, - but a different folder can be passed as second argument to the script. + - The linters require`clang-format-18` and `clang-tidy-18`. + - It is mandatory to have a build before running the linters. + - `clang-tidy` expects to find a `compile_commands.json` in a build folder. + - It is recommended to build with _gcc_ and in _Release_ mode. + - We have observed `clang-tidy` fails to find some standard headers when compiling with _clang_. + - `run_cpp_linters.py` can receive a build folder as second argument, but defaults to `build/Release`. ## Docker