doc: Show how less noisy clang-tidy output can be achieved #27205
Conversation
|
ConceptACK |
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. ReviewsSee the guideline for information on the review process.
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update. |
doc/developer-notes.md
Outdated
| from externally included headers. Additionally a default bear configuration | ||
| file can be found in `src/.bear-tidy-config`. It contains rules excluding | ||
| in-tree dependency headers and may be passed to bear with `--config | ||
| src/.bear-tidy-config`. |
There was a problem hiding this comment.
Why not just modify the above command to include this? (And then mention that --config can be omitted, if someone really wants to)
I'd suspect that you run into a wall of errors anyway without --config
There was a problem hiding this comment.
I don't mind either way. I added a separate explainer, because it felt a bit too information-dense otherwise. Also, I only have bear version 3 to test. Does bear version 2 also accept --config?
6a29f34 to
d880c78
Compare
|
Updated 6a29f34 -> d880c78 (dev-notes-clang-tidy_0 -> dev-notes-clang-tidy_1, compare) to address @MarcoFalke's feedback. |
8d4e0e8 to
3d524c9
Compare
|
Updated 6a29f34 -> 3d524c9 (dev-notes-clang-tidy_1 -> dev-notes-clang-tidy_2, compare) to fix typos and trailing newline. |
3d524c9 to
54c4d03
Compare
|
Updated 3d524c9 -> 54c4d03 (dev-notes-clang-tidy_2 -> dev-notes-clang-tidy_3, compare) to get rid of the old documentation paragraph @fanquake . |
|
utACK 54c4d03 |
…e achieved 54c4d03 doc: Show how less noisy clang-tidy output can be achieved (TheCharlatan) Pull request description: Adds a paragraph to the clang-tidy section explaining how to de-noise its output. By default clang-tidy will print errors arrising from included headers in leveldb and other dependencies. By passing `--enable-suppress-external-warnings` flag to configure, errors arising from external dependencies are suppressed. Additional errors arrising from internal dependencies such as leveldb are suppressed by passing the `src/.bear-tidy-config` configuration file to bear. This file includes exclusionary rules for leveldb. ACKs for top commit: MarcoFalke: utACK 54c4d03 Tree-SHA512: c3dd8fb0600157582a38365a587e02e1d249fb246d6b8b4949a800fd05d3473dee49e2a4a556c60e51d6508feff810024e55fe09f5a0875f560fde30f3b6817c
Adds a paragraph to the clang-tidy section explaining how to de-noise its output. By default clang-tidy will print errors arrising from included headers in leveldb and other dependencies. By passing
--enable-suppress-external-warningsflag to configure, errors arising from external dependencies are suppressed. Additional errors arrising from internal dependencies such as leveldb are suppressed by passing thesrc/.bear-tidy-configconfiguration file to bear. This file includes exclusionary rules for leveldb.