Add sccache to development.md prerequisites#719
Add sccache to development.md prerequisites#719fuleinist wants to merge 1 commit intothunderbird:mainfrom
Conversation
cjroth
left a comment
There was a problem hiding this comment.
We reorganized the docs since you submitted this, but this is a needed update. If you want to update the PR to the latest main branch, I can merge it.
| You must have Bun, Rust, and Docker installed first. Then: | ||
| You must have Bun, Rust, sccache, and Docker installed first. Then: | ||
|
|
||
| > **Note**: The Rust build uses `sccache` (configured in `src-tauri/.cargo/config.toml`) to speed up rebuilds. Install it with: `cargo install sccache` |
There was a problem hiding this comment.
Thanks for the suggestion! Would it make sense to recommend cargo install sccache here?
There was a problem hiding this comment.
Actually - can we move this to the sh section below as a command with a command instead?
| You must have Bun, Rust, and Docker installed first. Then: | ||
| You must have Bun, Rust, sccache, and Docker installed first. Then: | ||
|
|
||
| > **Note**: The Rust build uses `sccache` (configured in `src-tauri/.cargo/config.toml`) to speed up rebuilds. Install it with: `cargo install sccache` |
There was a problem hiding this comment.
Actually - can we move this to the sh section below as a command with a command instead?
|
Thanks for the review @cjroth! I've addressed the merge conflict and created a new PR #768 that targets the current main branch. Since The change in #768 is a single line addition: Happy to close #719 in favour of #768, or merge both — just let me know! |
|
Great - just merged #768. Appreciate the help. |
Problem
src-tauri/.cargo/config.toml uses rustc-wrapper = "sccache" to speed up Rust builds, but development.md's Quick Start does not mention installing sccache. Contributors following the docs will hit a silent failure on first clone.
Solution
Use case
First-time contributors cloning the repo will get a working Rust toolchain without trial-and-error debugging.
Closes #715
Note
Low Risk
Low risk documentation-only change; no code or runtime behavior is modified.
Overview
Updates
docs/development.mdQuick Start prerequisites to includesccacheand adds a note with install instructions, aligning the setup docs with the Rust build’srustc-wrapper = "sccache"configuration.Reviewed by Cursor Bugbot for commit f2a4802. Bugbot is set up for automated code reviews on this repo. Configure here.