doc: Show how less noisy clang-tidy output can be achieved #27205

1. 
   TheCharlatan commented at 10:58 PM on March 5, 2023: contributor

   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.

2. 
   RandyMcMillan commented at 4:58 PM on March 6, 2023: contributor

   ConceptACK

3. 
   DrahtBot commented at 4:58 PM on March 6, 2023: contributor

   <!--e57a25ab6845829454e8d69fc972939a-->

   The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

   <!--021abf342d371248e50ceaed478a90ca-->

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	MarcoFalke
   Concept ACK	RandyMcMillan
   Stale ACK	fanquake

   If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

4. fanquake approved
5. 
   fanquake commented at 7:56 AM on March 8, 2023: member

   ACK 6a29f34ac0afce501af45097916256a9bffe8d19 - seems fine.

6. in doc/developer-notes.md:245 in 6a29f34ac0 outdated

    233 | @@ -234,6 +234,13 @@ To run clang-tidy on the changed source lines:
    234 |  git diff | ( cd ./src/ && clang-tidy-diff -p2 -j $(nproc) )
    235 |  ```
    236 |  
    237 | +To achieve a less noisy clang-tidy output, run configure with the
    238 | +`--enable-suppress-external-warnings` flag. This will suppress warnings arising
    239 | +from externally included headers. Additionally a default bear configuration
    240 | +file can be found in `src/.bear-tidy-config`. It contains rules excluding
    241 | +in-tree dependency headers and may be passed to bear with `--config
    242 | +src/.bear-tidy-config`.
   

   ---

   ---

   

   maflcko commented at 12:54 PM on March 10, 2023:

   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

   ---

   

   TheCharlatan commented at 1:31 PM on March 10, 2023:

   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?

   ---

   

   maflcko commented at 1:36 PM on March 10, 2023:

   Seems fine to drop version 2

7. TheCharlatan force-pushed on Mar 10, 2023
8. 
   TheCharlatan commented at 3:16 PM on March 10, 2023: contributor

   Updated 6a29f34ac0afce501af45097916256a9bffe8d19 -> d880c78e708d3cb0c44631e3be759d6991d5a910 (dev-notes-clang-tidy_0 -> dev-notes-clang-tidy_1, compare) to address @MarcoFalke's feedback.

9. TheCharlatan force-pushed on Mar 10, 2023
10. TheCharlatan force-pushed on Mar 10, 2023
11. TheCharlatan force-pushed on Mar 10, 2023
12. 
    TheCharlatan commented at 3:41 PM on March 10, 2023: contributor

    Updated https://github.com/bitcoin/bitcoin/commit/6a29f34ac0afce501af45097916256a9bffe8d19 -> 3d524c9d4664026c318c2ec90baacc2bee4f4525 (dev-notes-clang-tidy_1 -> dev-notes-clang-tidy_2, compare) to fix typos and trailing newline.

13. in doc/developer-notes.md:240 in 3d524c9d46 outdated

     236 | @@ -234,6 +237,13 @@ To run clang-tidy on the changed source lines:
     237 |  git diff | ( cd ./src/ && clang-tidy-diff -p2 -j $(nproc) )
     238 |  ```
     239 |  
     240 | +To achieve a less noisy clang-tidy output, run configure with the
    

    ---

    ---

    

    fanquake commented at 3:44 PM on March 10, 2023:

    Think you forgot to drop this?

14. doc: Show how less noisy clang-tidy output can be achieved 54c4d03578
15. TheCharlatan force-pushed on Mar 10, 2023
16. 
    TheCharlatan commented at 3:56 PM on March 10, 2023: contributor

    Updated 3d524c9d4664026c318c2ec90baacc2bee4f4525 -> 54c4d03578c5842f19bf8bc68aca5faf8beed5c3 (dev-notes-clang-tidy_2 -> dev-notes-clang-tidy_3, compare) to get rid of the old documentation paragraph @fanquake .

17. 
    maflcko commented at 4:24 PM on March 10, 2023: member

    utACK 54c4d03578c5842f19bf8bc68aca5faf8beed5c3

18. DrahtBot requested review from fanquake on Mar 10, 2023
19. fanquake merged this on Mar 10, 2023
20. fanquake closed this on Mar 10, 2023

    ---

21. sidhujag referenced this in commit 9af7efbe9b on Mar 12, 2023
22. bitcoin locked this on Mar 9, 2024

Contributors

TheCharlatanRandyMcMillanDrahtBotfanquakemaflcko

Review Requested
fanquake