Skip to content

Clarify help message of rustup toolchain help link #2278

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

Merged
merged 1 commit into from
Apr 4, 2020
Merged

Clarify help message of rustup toolchain help link #2278

merged 1 commit into from
Apr 4, 2020

Conversation

ssomers
Copy link
Contributor

@ssomers ssomers commented Apr 3, 2020

Fixes #2276.
And tries to mimic the style of other options.

@ssomers
Copy link
Contributor Author

ssomers commented Apr 3, 2020

Help message then looks like this:

rustup.exe-toolchain-link
Create a custom toolchain by symlinking to a directory

USAGE:
    rustup.exe toolchain link <toolchain> <path>

FLAGS:
    -h, --help    Prints help information

ARGS:
    <toolchain>    Custom toolchain name
    <path>         Path to the directory

DISCUSSION:
    'toolchain' is the custom name to be assigned to the new toolchain.
    Any name is permitted as long as it does not fully match an initial
    substring of a standard release channel. For example, you can use
    the names 'latest' or '2017-04-01' but you cannot use 'stable' or
    'beta-i686' or 'nightly-x86_64-unknown-linux-gnu'.

    'path' specifies the directory where the binaries and libraries for
    the custom toolchain can be found. For example, when used for
    development of Rust itself, toolchains can be linked directly out of
    the build directory. After building, you can test out different
    compiler versions as follows:

        $ rustup toolchain link latest-stage1 build/x86_64-unknown-linux-gnu/stage1
        $ rustup override set latest-stage1

    If you now compile a crate in the current directory, the custom
    toolchain 'latest-stage1' will be used.

Copy link
Contributor

@kinnison kinnison left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This certainly looks more correct.

Thank you for your contribution.

@kinnison kinnison merged commit 93e6d7d into rust-lang:master Apr 4, 2020
@ssomers ssomers deleted the fix2276 branch April 4, 2020 11:01
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 toolchain help link has misleading help message for <toolchain>
2 participants