rust-lang / rust-lang/docs.rs

Support using custom toolchains

Open
#1,310 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-builds C-enhancement P-low
Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

I tried using a local build of rust-lang/rust for testing, but rustwide gives an error while initializing:

2021/03/07 10:35:01 [INFO] rustwide::cmd: running `Command { std: "/home/joshua/docs.rs/.workspace/cargo-home/bin/rustup" "target" "list" "--installed" "--toolchain" "rustc2", kill_on_drop: false }`
Error: Building documentation failed

Caused by:
    failed to read the list of installed targets for rustc2 with rustup

Caused by:
    command failed: exit code: 1
$ "/home/joshua/docs.rs/.workspace/cargo-home/bin/rustup" "target" "list" "--installed" "--toolchain" "rustc2"
error: toolchain 'rustc2' does not support components
error: caused by: rustc2 is a custom toolchain

Not yet sure if this is a docs.rs bug or a rustwide bug - maybe the best solution is for rustwide to detect a custom toolchain and add a new error variant for that?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the rustup target-list command shown in the report with the custom toolchain rustc2, then trace whether initialization is handled by docs.rs or rustwide. Determine the intended behavior for custom toolchains and verify that documentation builds either succeed or report a dedicated, actionable error.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.