Skip to content

rustup doc should deal with absent doc instead of silently failing #901

Description

@toastedcornflakes

On a new install of rustup, running rustup doc fails silently if the documentation is not installed: the browser does not open, and there is no error message.

Would it be OK to add an error message, or to automatically run rustup component add rust-docs ?

This is tangentially related to #891 — if the doc is installed by default, this issue would be moot.

Activity

  1. changed the title [-]rustup should explain how to install the doc instead of silently failing[/-] [+]rustup doc should deal with absent doc instead of silently failing[/+] on Jan 5, 2017
  2. dgellow commented on Jan 27, 2017

    @dgellow

    @toastedcornflakes ah thank you for this issue! I was trying to understand why rustup doc --book doesn't seem to work.

  3. Zteve commented on Feb 9, 2017

    @Zteve

    +1

  4. RalfJung commented on Apr 11, 2017

    @RalfJung
    Member

    It doesn't fail silently here, but it fails: When I do rustup doc, I get the following error:

    Unable to run the command specified. The file or folder /home/r/.rustup/toolchains/stable-x86_64-unknown-linux-gnu/share/doc/rust/html/index.html does not exist.
    

    It is not at all obvious to me how to even install the docs. rustup help doc doesn't tell me. Seems like I will have to do some more googling...

  5. added a commit that references this issue on Nov 10, 2019
    bb593bb
  6. kinnison commented on Nov 10, 2019

    @kinnison
    Contributor

    I'd appreciate input on whether or not #2116 is sufficient

  7. toastedcornflakes commented on Nov 10, 2019

    @toastedcornflakes
    Author

    #2116 is what I had in mind when I raised this, thanks!

  8. kinnison commented on Nov 10, 2019

    @kinnison
    Contributor

    Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions