docs(contributing): document the fast t27c inner loop - #5945
Merged
Merged
Conversation
The only build CONTRIBUTING named was a release build, which has no incremental compilation, so every edit cost ~30 s. Add a Build speed section: cargo check, debug and incremental release rebuild in 2.4-5.0 s on an idle M1 Pro. It also covers not benchmarking incremental builds, TRI_T27C for debug binaries, and the compiler.rs seal step whose printed remedy fails (#5928). CLAUDE.md section 2 points to it. Closes #5934 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
12 tasks
Contributor
Contributor
|
📓 NotebookLM Notebook linked to this PR
This notebook contains session context, decisions, and artifacts for this work. |
This was referenced Oct 4, 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.
Closes #5934. Part of #5905 (weak point 5, last checklist row).
What changes
CONTRIBUTING.mdgains a "Build speed" section. The only build it named before was the release build, which has no incremental compilation, so each edit cost about 30 s.cargo check -p t27ccargo build -p t27cCARGO_PROFILE_RELEASE_INCREMENTAL=true cargo build --release -p t27ccargo build --release -p t27cThe section also covers three things that were not written down:
scripts/tripreferstarget/release/t27cover a fresher debug binary, so iterating with debug builds needsTRI_T27C=target/debug/t27c.compiler.rsseal. The remedy thatbuild.rsandFROZEN.mdprint,cargo run --release -- frozen-digest, panics again after the edit (build.rs FROZEN_HASH panic tells you to run a command that hits the same panic #5928). The section names two routes that work: a binary built before the edit, orshasum -a 256. All three print the same digest:The section links to the ceremony in
FROZEN.mdinstead of restating it.CLAUDE.mdsection 2 gains one pointer line, not a copy.Where the numbers come from
They were measured on 2026-10-04 on an idle M1 Pro (8 cores), adding one function to
bootstrap/src/suite.rs, with a warm-up build first. The debug row usedCARGO_PROFILE_DEV_DEBUG=0.I also tried to time edits to
compiler.rsitself. The machine was at load average 200-300, and a debug rebuild took 137-215 s, so those numbers measure contention, not the build. They are not in the doc, and the section sayscompiler.rswas not timed on an idle machine.Not changed
No
[profile]edit and no.cargo/config, so CI and release builds are unchanged.🤖 Generated with Claude Code