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

Consistently give toolchain argument a help text #1212

Merged
merged 1 commit into from
Aug 13, 2017

Conversation

mgeisler
Copy link
Contributor

This adds a help text to every toolchain command line argument. The
help text for 'rustup default' now reads:

rustup-default
Set the default toolchain

USAGE:
    rustup default <toolchain>

FLAGS:
    -h, --help    Prints help information

ARGS:
    <toolchain>    Toolchain name, such as 'stable', 'nightly', or '1.8.0'.
                   For more information see `rustup help toolchain`

DISCUSSION:
    Sets the default toolchain to the one specified. If the toolchain
    is not already installed then it is installed first.

Two commands (update and install) already explained what the toolchain
argument was -- but it was explained in the freeform "after help"
text. These explanations have been moved to the arguments themselves
for consistency.

Fixes #923.

@bors
Copy link
Contributor

bors commented Aug 11, 2017

☔ The latest upstream changes (presumably #1214) made this pull request unmergeable. Please resolve the merge conflicts.

@alexcrichton
Copy link
Member

@bors: r+

Thanks!

@bors
Copy link
Contributor

bors commented Aug 12, 2017

📌 Commit 8c4632f has been approved by alexcrichton

@bors
Copy link
Contributor

bors commented Aug 12, 2017

☔ The latest upstream changes (presumably #1213) made this pull request unmergeable. Please resolve the merge conflicts.

@bors
Copy link
Contributor

bors commented Aug 13, 2017

🔒 Merge conflict

This adds a help text to every toolchain command line argument. The
help text for 'rustup default' now reads:

  rustup-default
  Set the default toolchain

  USAGE:
      rustup default <toolchain>

  FLAGS:
      -h, --help    Prints help information

  ARGS:
      <toolchain>    Toolchain name, such as 'stable', 'nightly', or '1.8.0'.
                     For more information see `rustup help toolchain`

  DISCUSSION:
      Sets the default toolchain to the one specified. If the toolchain
      is not already installed then it is installed first.

Two commands (update and install) already explained what the toolchain
argument was -- but it was explained in the freeform "after help"
text. These explanations have been moved to the arguments themselves
for consistency.

Fixes rust-lang#923.
@mgeisler mgeisler force-pushed the toolchain-arg-help branch from 8c4632f to fab6588 Compare August 13, 2017 08:53
@mgeisler
Copy link
Contributor Author

Rebased and resolved the merge conflicts.

@alexcrichton
Copy link
Member

@bors: r+

Thanks!

@bors
Copy link
Contributor

bors commented Aug 13, 2017

📌 Commit fab6588 has been approved by alexcrichton

@bors
Copy link
Contributor

bors commented Aug 13, 2017

⌛ Testing commit fab6588 with merge ac5bffa...

bors added a commit that referenced this pull request Aug 13, 2017
Consistently give toolchain argument a help text

This adds a help text to every toolchain command line argument. The
help text for 'rustup default' now reads:
```
rustup-default
Set the default toolchain

USAGE:
    rustup default <toolchain>

FLAGS:
    -h, --help    Prints help information

ARGS:
    <toolchain>    Toolchain name, such as 'stable', 'nightly', or '1.8.0'.
                   For more information see `rustup help toolchain`

DISCUSSION:
    Sets the default toolchain to the one specified. If the toolchain
    is not already installed then it is installed first.
```

Two commands (update and install) already explained what the toolchain
argument was -- but it was explained in the freeform "after help"
text. These explanations have been moved to the arguments themselves
for consistency.

Fixes #923.
@bors
Copy link
Contributor

bors commented Aug 13, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing ac5bffa to master...

@bors bors merged commit fab6588 into rust-lang:master Aug 13, 2017
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.

3 participants