fix(cli): Make --help easier to browse
#11905
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @weihanglo (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
A-cli
epage
added a commit
to epage/cargo
that referenced
this pull request
Mar 29, 2023
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
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
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
This makes it easier to evaluate the usability of PRs, like rust-lang#11905
weihanglo
reviewed
Apr 12, 2023
|
☔ The latest upstream changes (presumably #12157) made this pull request unmergeable. Please resolve the merge conflicts. |
weihanglo
reviewed
May 20, 2023
There was a problem hiding this comment.
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 test(cli): Track --help output #11912?
People better not be relying on
That is why I have not been working to move this forward. |
epage
added a commit
to epage/cargo
that referenced
this pull request
Jun 6, 2023
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
This makes it easier to evaluate the usability of PRs, like rust-lang#11905
bors
added a commit
that referenced
this pull request
Jul 24, 2023
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
epage
force-pushed
the
help_heading
branch
2 times, most recently
from
830931e to
d500051
Compare
epage
changed the title
--help easier to browse--help easier to browse
weihanglo
approved these changes
Aug 8, 2023
|
@bors r+ |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
1 similar comment
|
☀️ Test successful - checks-actions |
|
👀 Test was successful, but fast-forwarding failed: 422 Changes must be made through a pull request. |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Aug 13, 2023
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`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This mirrors some of the categories from
cargo help(the man pages) usingclap::Arg::help_heading.There are fewer categories to avoid extra vertical space. Instead, they
are left int the
Optionscategory but put first.The goal is to try to make it easier to scan
--helpoutput as the list of flags can get quite long and its easy to miss what features are there.