Cleanly report when rust-docs isn't installed #2116
Merged
Conversation
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
When the user runs `rustup doc` on a toolchain which doesn't have the `rust-docs` component installed, we now report more nicely that the user ought to try and install the component. Fixes rust-lang#901 Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
Contributor
Author
|
For reference the UX is: somniloquy% rustup component remove rust-docs
info: removing component 'rust-docs'
somniloquy% rustup doc
info: `rust-docs` not installed in toolchain `stable-x86_64-unknown-linux-gnu`
info: To install, try `rustup component add --toolchain stable-x86_64-unknown-linux-gnu rust-docs`
error: unable to view documentation which is not installed
zsh: exit 1 rustup doc
somniloquy% rustup component add --toolchain stable-x86_64-unknown-linux-gnu rust-docs
info: downloading component 'rust-docs'
11.7 MiB / 11.7 MiB (100 %) 6.6 MiB/s in 3s ETA: 0s
info: installing component 'rust-docs'
11.7 MiB / 11.7 MiB (100 %) 2.8 MiB/s in 3s ETA: 0s
somniloquy% |
cuviper
added a commit
to cuviper/rustup.rs
that referenced
this pull request
Feb 21, 2020
Following rust-lang#2116, custom toolchains started to fail `rustup doc`, since they can't list components to check if `rust-docs` is installed. error: toolchain 'system' does not support components error: caused by: invalid toolchain name: 'system' Now custom toolchains just skip that component check, and it's up to the user to have installed the documentation in their own way.
rbtcollins
pushed a commit
that referenced
this pull request
Feb 24, 2020
Following #2116, custom toolchains started to fail `rustup doc`, since they can't list components to check if `rust-docs` is installed. error: toolchain 'system' does not support components error: caused by: invalid toolchain name: 'system' Now custom toolchains just skip that component check, and it's up to the user to have installed the documentation in their own way.
BeniCheni
pushed a commit
to BeniCheni/rustup.rs
that referenced
this pull request
May 10, 2020
Following rust-lang#2116, custom toolchains started to fail `rustup doc`, since they can't list components to check if `rust-docs` is installed. error: toolchain 'system' does not support components error: caused by: invalid toolchain name: 'system' Now custom toolchains just skip that component check, and it's up to the user to have installed the documentation in their own way.
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.
When the user runs
rustup docon a toolchain which doesn'thave the
rust-docscomponent installed, we now report morenicely that the user ought to try and install the component.
Fixes #901