Skip to content

Add sccache to development.md prerequisites#719

Closed
fuleinist wants to merge 1 commit intothunderbird:mainfrom
fuleinist:add-sccache-prereq
Closed

Add sccache to development.md prerequisites#719
fuleinist wants to merge 1 commit intothunderbird:mainfrom
fuleinist:add-sccache-prereq

Conversation

@fuleinist
Copy link
Copy Markdown
Contributor

@fuleinist fuleinist commented Apr 22, 2026

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

  • Add sccache to the list of required tools in the Quick Start section
  • Add a note explaining what sccache is and how to install it

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.md Quick Start prerequisites to include sccache and adds a note with install instructions, aligning the setup docs with the Rust build’s rustc-wrapper = "sccache" configuration.

Reviewed by Cursor Bugbot for commit f2a4802. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown
Member

@cjroth cjroth left a comment

Choose a reason for hiding this comment

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

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.

Comment thread docs/development.md
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`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the suggestion! Would it make sense to recommend cargo install sccache here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Actually - can we move this to the sh section below as a command with a command instead?

Comment thread docs/development.md
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`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Actually - can we move this to the sh section below as a command with a command instead?

@fuleinist
Copy link
Copy Markdown
Contributor Author

Thanks for the review @cjroth! I've addressed the merge conflict and created a new PR #768 that targets the current main branch.

Since docs/development.md was reorganized into docs/development/quick-start.md in THU-391, I've integrated the sccache prerequisite note into the Prerequisites section there.

The change in #768 is a single line addition:

- **sccache** — speeds up Rust rebuilds. Install with `cargo install sccache`. Configured in `src-tauri/.cargo/config.toml`.

Happy to close #719 in favour of #768, or merge both — just let me know!

@cjroth cjroth closed this in #768 Apr 27, 2026
@cjroth
Copy link
Copy Markdown
Member

cjroth commented Apr 27, 2026

Great - just merged #768. Appreciate the help.

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.

Add sccache to development.md prerequisites

2 participants