docs: Add note about clang-tidy installation - #6634
Merged
Merged
Conversation
godexsoft
marked this pull request as ready for review
March 24, 2026 18:29
mvadari
reviewed
Mar 24, 2026
| brew install llvm@21 | ||
| ``` | ||
|
|
||
| Then use `run-clang-tidy` from the LLVM 21 Homebrew prefix when running clang-tidy locally. |
Contributor
There was a problem hiding this comment.
Can you include the instructions on how to run it (e.g. what command), given that this confused me too?
Contributor
Author
There was a problem hiding this comment.
But that was already in CONTRIBUTING.md all along, is that not enough? Maybe we can specify how to use -fix though, that is missing I guess.
Contributor
There was a problem hiding this comment.
Ah sorry, it wasn't in the diff so I missed it. Perhaps worth adding include to the list as well though.
Contributor
There was a problem hiding this comment.
This is the command I'm using now:
run-clang-tidy -j 10 -p .build -fix $(git diff --name-only develop)
mvadari
approved these changes
Mar 24, 2026
clang-tidy installationclang-tidy installation
bthomee
enabled auto-merge
March 24, 2026 21:17
beartec-jpg
pushed a commit
to beartec-jpg/FalconLedger
that referenced
this pull request
Jun 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
High Level Overview of Change
This PR adds installation instructions for clang-tidy.