fix(cli): Make `--help` easier to browse by epage · Pull Request #11905 · rust-lang/cargo

epage · 2023-03-28T21:45:59Z

This mirrors some of the categories from cargo help (the man pages) using clap::Arg::help_heading.
There are fewer categories to avoid extra vertical space. Instead, they
are left int the Options category but put first.

The goal is to try to make it easier to scan --help output as the list of flags can get quite long and its easy to miss what features are there.

rustbot · 2023-03-28T21:46:06Z

r? @weihanglo

(rustbot has picked a reviewer for you, use r? to override)

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

tests/testsuite/cargo_remove/invalid_arg/stderr.log

bors · 2023-05-20T17:11:01Z

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

weihanglo

This seems awesome! I am happy to help move it forward.

At least two things need to figure out I guess:

Will it break shell completions?
Should we somehow first integrate #11912?

epage · 2023-05-22T18:58:49Z

Will it break shell completions?

People better not be relying on --help for compeltions; clap has already changed things out from under people

Should we somehow first integrate #11912?

That is why I have not been working to move this forward.

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

test(cli): Track --help output ### What does this PR try to resolve? This makes it easier to evaluate the usability of PRs, like #11905 This follows the pattern of `cargo add` and `cargo remove` of putting these ui tests in `cargo_<cmd>/` directories. `init` didn't follow this pattern, so it was renamed to `cargo_init/`. `cargo_config.rs` was going to conflict with this, it was merged in. We can evaluate other `<cmd>.rs` files at a later point and consolidate. ### How should we test and review this PR? The main risks are - Are all files linked together (`main.rs` -> `<cmd>/mod.rs` -> `<cmd>/<help>.rs` - Are all `help/mod.rs`s pointing to the right command

weihanglo

Thanks a lot. Let's move on!

weihanglo · 2023-08-08T20:35:46Z

@bors r+

bors · 2023-08-08T20:35:47Z

📌 Commit 853102f has been approved by weihanglo

It is now in the queue for this repository.

bors · 2023-08-08T20:35:54Z

⌛ Testing commit 853102f with merge 2b3554f...

bors · 2023-08-08T21:21:07Z

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 2b3554f to master...

bors · 2023-08-08T21:21:07Z

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 2b3554f to master...

bors · 2023-08-08T21:21:11Z

👀 Test was successful, but fast-forwarding failed: 422 Changes must be made through a pull request.

Update cargo 21 commits in d78bbf4bde3c6b95caca7512f537c6f9721426ff..7e9de3f4ec3708f500bec142317895b96131e47c 2023-08-03 12:58:25 +0000 to 2023-08-13 00:47:32 +0000 - feat: remove `--keep-going` from `cargo test/bench` (rust-lang/cargo#12478) - chore: window-sys should be a platform-specific dependency (rust-lang/cargo#12483) - docs: make the env var source of rerun-if-env-changed clearer (rust-lang/cargo#12482) - doc: note the backward compatible `.cargo/credential` file exists (rust-lang/cargo#12479) - Fix elided lifetime in associated const (rust-lang/cargo#12475) - prompt the use of `--nocapture` flag if `cargo test` process is terminated via a signal. (rust-lang/cargo#12463) - cargo-credential: reset stdin & stdout to the Console (rust-lang/cargo#12469) - Fix cargo remove incorrectly removing used patches (rust-lang/cargo#12454) - chore(gh): Expand update window (rust-lang/cargo#12466) - Fix panic when enabling http.debug for certain strings (rust-lang/cargo#12468) - fix(cli): Make `--help` easier to browse (rust-lang/cargo#11905) - fix: preserve jobserver file descriptors on rustc invocation to get `TargetInfo` (rust-lang/cargo#12447) - refactor: migrate to `tracing` (rust-lang/cargo#12458) - docs: add example for cargo-credential (rust-lang/cargo#12461) - Bail out an error when using cargo:: in custom build script (rust-lang/cargo#12332) - Fix printing multiple warning messages for unused fields in [registries] table (rust-lang/cargo#12439) - Update windows dependencies (rust-lang/cargo#12453) - Rustfmt a let-else statement (rust-lang/cargo#12451) - Add allow(internal_features) (rust-lang/cargo#12450) - Update pretty_env_logger to 0.5 (rust-lang/cargo#12445) - Remove build metadata from libgit2-sys dependency (rust-lang/cargo#12444) r? `@ghost`

rustbot assigned weihanglo Mar 28, 2023

rustbot added A-cli Area: Command-line interface, option parsing, etc. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 28, 2023

epage added a commit to epage/cargo that referenced this pull request Mar 29, 2023

test(cli): Track --help output

ea84381

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

epage mentioned this pull request Mar 29, 2023

test(cli): Track --help output #11912

Merged

epage added a commit to epage/cargo that referenced this pull request Mar 30, 2023

test(cli): Track --help output

1a6d074

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

epage added a commit to epage/cargo that referenced this pull request Mar 30, 2023

test(cli): Track --help output

7e5a07b

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

epage added a commit to epage/cargo that referenced this pull request Mar 31, 2023

test(cli): Track --help output

e5b9f23

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

weihanglo reviewed Apr 12, 2023

View reviewed changes

tests/testsuite/cargo_remove/invalid_arg/stderr.log Show resolved Hide resolved

weihanglo reviewed May 20, 2023

View reviewed changes

epage force-pushed the help_heading branch from 81c785c to 2a32818 Compare June 6, 2023 21:38

epage added a commit to epage/cargo that referenced this pull request Jun 6, 2023

test(cli): Track --help output

0e6ad5b

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

epage added a commit to epage/cargo that referenced this pull request Jul 24, 2023

test(cli): Track --help output

5101372

This makes it easier to evaluate the usability of PRs, like rust-lang#11905

epage force-pushed the help_heading branch 2 times, most recently from 830931e to d500051 Compare July 25, 2023 01:05

rustbot added Command-bench Command-build Command-check Command-doc Command-fix Command-package Command-run Command-rustc Command-rustdoc Command-test Command-tree labels Jul 25, 2023

rustbot added Command-metadata Command-new Command-owner Command-pkgid Command-publish Command-remove Command-search Command-uninstall Command-update Command-vendor Command-yank labels Aug 8, 2023

epage changed the title ~~PoC: Make --help easier to browse~~ fix(cli): Make --help easier to browse Aug 8, 2023

epage marked this pull request as ready for review August 8, 2023 20:04

weihanglo approved these changes Aug 8, 2023

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 8, 2023

bors merged commit 2b3554f into rust-lang:master Aug 8, 2023

epage deleted the help_heading branch August 8, 2023 21:22

bors mentioned this pull request Aug 8, 2023

Add unstable --output-format option to cargo rustdoc #12252

Merged

weihanglo mentioned this pull request Aug 13, 2023

Update cargo rust-lang/rust#114773

Merged

ehuss added this to the 1.73.0 milestone Aug 22, 2023

epage mentioned this pull request Oct 24, 2023

Quest issue: how can we improve --help output #6104

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(cli): Make `--help` easier to browse#11905

fix(cli): Make `--help` easier to browse#11905
bors merged 1 commit intorust-lang:masterfrom
epage:help_heading

epage commented Mar 28, 2023 •

edited

Loading

Uh oh!

rustbot commented Mar 28, 2023

Uh oh!

Uh oh!

bors commented May 20, 2023

Uh oh!

weihanglo left a comment

Uh oh!

epage commented May 22, 2023

Uh oh!

weihanglo left a comment

Uh oh!

weihanglo commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

epage commented Mar 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Mar 28, 2023

Uh oh!

Uh oh!

bors commented May 20, 2023

Uh oh!

weihanglo left a comment

Choose a reason for hiding this comment

Uh oh!

epage commented May 22, 2023

Uh oh!

weihanglo left a comment

Choose a reason for hiding this comment

Uh oh!

weihanglo commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

bors commented Aug 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

epage commented Mar 28, 2023 •

edited

Loading