Skip to content

docs: add cargo check workaround for macOS + Homebrew LLVM#30965

Open
shguddn8591 wants to merge 1 commit into
oven-sh:mainfrom
shguddn8591:claude/docs-macos-cargo-check-workaround-v2
Open

docs: add cargo check workaround for macOS + Homebrew LLVM#30965
shguddn8591 wants to merge 1 commit into
oven-sh:mainfrom
shguddn8591:claude/docs-macos-cargo-check-workaround-v2

Conversation

@shguddn8591
Copy link
Copy Markdown

What does this PR do?

Added a documentation section in CONTRIBUTING.md to help contributors run cargo check on macOS when using Homebrew's llvm@21.

Homebrew's llvm@21 does not support the -fuse-ld=lld flag, which causes linker errors when running cargo check --workspace directly. This PR documents the RUSTFLAGS="" workaround and clarifies that official build commands (bun bd, bun run build) are unaffected.

How did you verify your code works?

  • Confirmed that RUSTFLAGS="" cargo check --workspace --keep-going succeeds on macOS with Homebrew llvm@21.
  • Verified that the new documentation section renders correctly in CONTRIBUTING.md.

Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@shguddn8591
Copy link
Copy Markdown
Author

@claude review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: ef7cd119-de48-46a7-afe9-ac4c44349613

📥 Commits

Reviewing files that changed from the base of the PR and between 9ecb985 and cf2863f.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Walkthrough

This PR adds macOS-specific troubleshooting documentation to CONTRIBUTING.md, explaining that Homebrew's llvm@21 does not support the -fuse-ld=lld flag and providing a workaround command for running cargo check successfully.

Changes

macOS Homebrew LLVM Troubleshooting Documentation

Layer / File(s) Summary
macOS Homebrew LLVM troubleshooting guide
CONTRIBUTING.md
New subsection documents that Homebrew's llvm@21 does not support -fuse-ld=lld and provides a workaround command using RUSTFLAGS="" cargo check --workspace --keep-going; also notes that official bun bd and bun run build commands apply this fix automatically.

Possibly related issues

  • oven-sh/bun#30870: This documentation directly addresses the macOS linker flag problem (llvm@21 not accepting -fuse-ld=lld) that was reported in this issue.

Possibly related PRs

  • oven-sh/bun#30708: Both PRs update CONTRIBUTING.md with Rust iteration guidance around cargo check, with this PR adding the specific macOS llvm@21 and -fuse-ld=lld troubleshooting workaround.
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly describes the main change: adding a cargo check workaround documentation for macOS with Homebrew LLVM, matching the primary purpose of the PR.
Description check ✅ Passed The PR description fully covers both required template sections with clear explanations of what was added and how it was verified, meeting all documentation requirements.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant