Rust documentation is outdated
Metadata
Current evaluation
Rust plugin docs were corrected by merged PR #1681 (commit e66bea2f), removing obsolete rust-deps guidance and documenting the validation behavior from #903.
Resolution: closed resolved
Reason: PR #1681 merged commit e66bea2f, updating the Rust plugin reference to match current behavior and explicitly resolving #912.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### What needs to get done
The docs mention the `rust-deps` keyword which does not exist:
> you can set rust-deps: ["rustc", "cargo"] and rust-channel: "none" in the part definition to override the default behaviour.
The docs should also be updated to reflect #903, which adds
```
Configures the following validation rules:
* 'rust-channel' is null or 'after: [rust-deps]': validate that cargo and rustc are installed
and do not install rustup
* 'rust-channel' is defined: validate that rustup is installed
* 'rust-channel' and 'after: [rust-deps]' are defined: raise an error
```
### Why it needs to get done
To have correct documentation
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Rust plugin docs were corrected by merged PR #1681 (commit e66bea2f), removing obsolete rust-deps guidance and documenting the validation behavior from #903. | |
| stealth/space-bunny-alpha | — | closed resolved | Rust plugin documentation was updated by merged PR #1681 (commit e66bea2f), resolving outdated behavior details tracked in #912. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed. Documentation updates were redirected to Jira ticket CRAFT-3723. No code fix or merge was applied, leaving the issue pending external resolution. | |
| qwen/qwen3.8-27b |
Impact:
25
Quick Win:
22
Staleness:
62
Complexity:
10
Confidence:
85
Support Request:
0
|
keep open | Rust plugin docs still reference a nonexistent rust-deps keyword and lack the validation rules added in PR #903. Outdated text remains in the docs; open PR #1681 (approved) fixes this issue. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
10
Confidence:
80
Support Request:
5
|
needs triage | Documentation incorrectly references a non-existent rust-deps keyword and needs updating to reflect recent validation rule changes. Currently unlabelled and awaiting maintainer review. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
85
Complexity:
10
Confidence:
80
Support Request:
10
|
needs triage | Documentation references a deprecated rust-deps keyword and needs updating to reflect changes from PR 903. Unlabeled and inactive for over a year. |
Update history
| Date | Change |
|---|---|
| closed |
Related work
-
Likely Fixed By:
canonical/craft-parts#1681
(confidence 100%)
Merged documentation update that explicitly fixed #912.
-
Related To:
canonical/craft-parts#903
(confidence 98%)
Its corrected dependency-validation behavior was incorporated into the documentation.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1681 docs: update reference for the rust plugin | craft-parts | merged | Merged PR #1681 (commit e66bea2f) updated Rust plugin docs for current behavior, resolving outdated dependency guidance, rust-channel defaults, and provisioning details in #912 and #593. | |
| #559 New rust plugin fails to validate with a `rust-deps` part dependency | craft-parts | closed | Fixed by merged PR canonical/craft-parts#560 (commit fbefe6b8), correcting Rust plugin validation when a rust-deps part dependency is present. | |
| #544 docs: add documentation for Rust plugin | craft-parts | merged | Merged into main as commit 47496dd8, adding 148 lines of docs across3 files for the Rust plugin rewritten in #530; shipped in release 1.25.0 (#545). | |
| #593 Wrong default in docs for the Rust plugin | craft-parts | closed | Documentation was corrected in merged PR #1681 (commit e66bea2f): rust-channel now documents a None default and that Rust must be provisioned separately. | |
| #1467 rust plugin: new rustup | snapcraft | closed | Updated the Rust plugin’s outdated rustup download link via merged PR #2438 (commit ea6caa72b), resolving LP bug #1662960. |