Sponsored Content
Skip to content

docs: Add note about clang-tidy installation - #6634

Merged
bthomee merged 2 commits into
XRPLF:developfrom
godexsoft:chore/document-clang-tidy
Mar 24, 2026
Merged

docs: Add note about clang-tidy installation#6634
bthomee merged 2 commits into
XRPLF:developfrom
godexsoft:chore/document-clang-tidy

Conversation

@godexsoft

Copy link
Copy Markdown
Contributor

High Level Overview of Change

This PR adds installation instructions for clang-tidy.

@godexsoft
godexsoft requested a review from mvadari March 24, 2026 18:29
@godexsoft
godexsoft marked this pull request as ready for review March 24, 2026 18:29
Comment thread docs/build/environment.md
brew install llvm@21
```

Then use `run-clang-tidy` from the LLVM 21 Homebrew prefix when running clang-tidy locally.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you include the instructions on how to run it (e.g. what command), given that this confused me too?

@godexsoft godexsoft Mar 24, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah sorry, it wasn't in the diff so I missed it. Perhaps worth adding include to the list as well though.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the command I'm using now:

run-clang-tidy -j 10 -p .build -fix $(git diff --name-only develop)

@godexsoft godexsoft added Ready to merge *PR author* thinks it's ready to merge. Has passed code review. Perf sign-off may still be required. Trivial Simple change with minimal effect, or already tested. Only needs one approval. labels Mar 24, 2026
@bthomee bthomee changed the title chore: Add note about clang-tidy installation docs: Add note about clang-tidy installation Mar 24, 2026
@bthomee
bthomee enabled auto-merge March 24, 2026 21:17
@bthomee
bthomee added this pull request to the merge queue Mar 24, 2026
Merged via the queue into XRPLF:develop with commit dda1620 Mar 24, 2026
1 check passed
@mvadari mvadari added this to the 3.2.0 milestone May 20, 2026
beartec-jpg pushed a commit to beartec-jpg/FalconLedger that referenced this pull request Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ready to merge *PR author* thinks it's ready to merge. Has passed code review. Perf sign-off may still be required. Trivial Simple change with minimal effect, or already tested. Only needs one approval.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants