Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanly report when rust-docs isn't installed #2116

Merged
merged 1 commit into from
Nov 10, 2019

Conversation

kinnison
Copy link
Contributor

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 #901

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 <[email protected]>
@kinnison
Copy link
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%                                              

@kinnison kinnison added this to the 1.21.0 milestone Nov 10, 2019
@kinnison kinnison merged commit 35c9242 into rust-lang:master Nov 10, 2019
@kinnison kinnison deleted the kinnison/report-missing-docs branch November 10, 2019 16:19
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustup doc should deal with absent doc instead of silently failing
1 participant