diff options
| author | TheCharlatan <seb.kung@gmail.com> | 2023-03-05 23:47:27 +0100 |
|---|---|---|
| committer | TheCharlatan <seb.kung@gmail.com> | 2023-03-10 16:47:41 +0100 |
| commit | 54c4d03578c5842f19bf8bc68aca5faf8beed5c3 (patch) | |
| tree | 511eed9503517bc5399d399004989969910ce7f8 | |
| parent | 40c6c85c05812ee8bf824b639307b1ac17a001c4 (diff) | |
doc: Show how less noisy clang-tidy output can be achieved
| -rw-r--r-- | doc/developer-notes.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index f15df1bf73..40e5eb785f 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -217,11 +217,14 @@ apt install clang-tidy bear clang Then, pass clang as compiler to configure, and use bear to produce the `compile_commands.json`: ```sh -./autogen.sh && ./configure CC=clang CXX=clang++ -make clean && bear make -j $(nproc) # For bear 2.x -make clean && bear -- make -j $(nproc) # For bear 3.x +./autogen.sh && ./configure CC=clang CXX=clang++ --enable-suppress-external-warnings +make clean && bear --config src/.bear-tidy-config -- make -j $(nproc) ``` +The output is denoised of errors from external dependencies and includes with +`--enable-suppress-external-warnings` and `--config src/.bear-tidy-config`. Both +options may be omitted to view the full list of errors. + To run clang-tidy on all source files: ```sh |