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.

Sign up for GitHub

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

Jump to bottom

Improve help for rustup default -h #923

Closed
ghost opened this issue Jan 13, 2017 · 0 comments
Closed

Improve help for rustup default -h #923

ghost opened this issue Jan 13, 2017 · 0 comments
Labels
E-easy enhancement help wanted

Comments

@ghost
Copy link

ghost commented Jan 13, 2017

Running

> rustup default -h

returns:

rustup-default 
Set the default toolchain

USAGE:
    rustup default <toolchain>

FLAGS:
    -h, --help    Prints help information

ARGS:
    <toolchain>    


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

It's ok, but it also could include channels list, like:

  • stable
  • beta
  • nightly

Perhaps it could be easily achieved by:
https://docs.rs/clap/2.20.0/clap/struct.Arg.html#method.possible_values
mgeisler added a commit to mgeisler/rustup that referenced this issue Jul 23, 2017
@mgeisler
Consistently give toolchain argument a help text
5611373 
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 mentioned this issue Jul 23, 2017
Merged
alexcrichton pushed a commit to mgeisler/rustup that referenced this issue Aug 12, 2017
@mgeisler @alexcrichton
Consistently give toolchain argument a help text
8c4632f 
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 added a commit to mgeisler/rustup that referenced this issue Aug 13, 2017
@mgeisler
Consistently give toolchain argument a help text
fab6588 
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.
bors added a commit that referenced this issue Aug 13, 2017
@bors
Auto merge of #1212 - mgeisler:toolchain-arg-help, r=alexcrichton
ac5bffa 
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.
mattico pushed a commit to mattico/rustup.rs that referenced this issue Apr 5, 2018
@mgeisler @mattico
Consistently give toolchain argument a help text
1aab1db 
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-easy enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Diggsey