chore(tools): Remove doc pass from cargo_check - #933
Merged
Conversation
The `cargo doc` pass added in #900 dominates the cost of every check. Timing a one-line whitespace edit in `jp_config` with a warm cache: 163s and 190s on two runs with the pass enabled, against 16s and 18s with it disabled. rustdoc re-runs for the edited crate and everything downstream of it and has no incremental mode, so a change low in the dependency graph re-documents most of the workspace. That is the wrong price for a signal only needed before work leaves the machine. `cargo_check` is called many times per session, and the doc lints stay covered by `just docs-ci` on CI and by bacon's `doc` job locally. Removes the `docs` option along with the pass, returning the tool config to its pre-#900 shape. Signed-off-by: Jean Mertz <git@jeanmertz.com>
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
1 participant
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.
The
cargo docpass added in #900 dominates the cost of every check. Timing a one-line whitespace edit injp_configwith a warm cache: 163s and 190s on two runs with the pass enabled, against 16s and 18s with it disabled. rustdoc re-runs for the edited crate and everything downstream of it and has no incremental mode, so a change low in the dependency graph re-documents most of the workspace.That is the wrong price for a signal only needed before work leaves the machine.
cargo_checkis called many times per session, and the doc lints stay covered byjust docs-cion CI and by manual checks locally.Removes the
docsoption along with the pass, returning the tool config to its pre-#900 shape.