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

Show a summary for each command (cargo --list) #3726

Closed
malbarbo opened this issue Feb 17, 2017 · 2 comments · Fixed by #5807
Closed

Show a summary for each command (cargo --list) #3726

malbarbo opened this issue Feb 17, 2017 · 2 comments · Fixed by #5807
Labels
A-console-output Area: Terminal output, colors, progress bar, etc. A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted`

Comments

@malbarbo
Copy link
Contributor

Running cargo shows a list of commands with a summary for each, but cargo --list does not show a summary.

Probably a summary can just be showed for internal commands.
@alexcrichton
Copy link
Member

Seems reasonable to me!

@carols10cents carols10cents added A-console-output Area: Terminal output, colors, progress bar, etc. A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` labels Oct 2, 2017
@dwijnand
Copy link
Member

Had a look at this and two things:

  1. The strings that cargo prints don't match the about of the commands. For example for build, cargo prints "Compile the current project", while the about string is "Compile a local package and all of its dependencies". Is that fine? Which one should --list output?

  2. --list supports -v to output the path of the command (TIL!). Given the descriptions we want to add are for built-in commands, which don't have an associated "path", do you think it's fine to mix descriptions with paths, or is that confusing?

@dwijnand dwijnand mentioned this issue Jul 26, 2018
Merged
bors added a commit that referenced this issue Jul 27, 2018
@bors
Auto merge of #5807 - dwijnand:cargo-list-summary, r=alexcrichton
dab09a0 
Show the command summary when running cargo --list

Fixes #3726
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-console-output Area: Terminal output, colors, progress bar, etc. A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted`
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Show the command summary when running cargo --list dwijnand/cargo
4 participants
@alexcrichton @carols10cents @dwijnand @malbarbo