Clarify flag behavior in `cargo remove --help` #12823

calavera · 2023-10-14T15:52:47Z

What does this PR try to resolve?

I noticed what I believe are typos in cargo rm --help:

Section:
      --dev              Remove as development dependency
      --build            Remove as build dependency
      --target <TARGET>  Remove as dependency from the given target platform

This change updates that section with a more appropriate description of those flags.

How should we test and review this PR?

I've updated the relevant test for that help output.

Additional information

Sorry for not opening an issue about this. I believe it's easy enough to approve it if my assumption is correct.

rustbot · 2023-10-14T15:52:52Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @weihanglo (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

src/bin/cargo/commands/remove.rs

epage · 2023-10-16T19:53:54Z

Thanks!

@bors r+

bors · 2023-10-16T19:53:57Z

📌 Commit a8413d3 has been approved by epage

It is now in the queue for this repository.

bors · 2023-10-16T19:55:04Z

⌛ Testing commit a8413d3 with merge d360280...

Clarify flag behavior in `cargo remove --help` ### What does this PR try to resolve? I noticed what I believe are typos in `cargo rm --help`: ``` Section: --dev Remove as development dependency --build Remove as build dependency --target <TARGET> Remove as dependency from the given target platform ``` This change updates that section with a more appropriate description of those flags. ### How should we test and review this PR? I've updated the relevant test for that help output. ### Additional information Sorry for not opening an issue about this. I believe it's easy enough to approve it if my assumption is correct.

bors · 2023-10-16T20:16:05Z

💔 Test failed - checks-actions

weihanglo · 2023-10-16T20:59:15Z

Please run SNAPSHOTS=overwrite cargo test to update snapshots.

Signed-off-by: David Calavera <david.calavera@gmail.com>

calavera · 2023-10-17T10:38:26Z

sorry, I forgot to update the test output. Tests should pass now.

weihanglo · 2023-10-17T11:54:24Z

Thank you!

@bors r+

bors · 2023-10-17T11:54:26Z

📌 Commit 8849d25 has been approved by weihanglo

It is now in the queue for this repository.

bors · 2023-10-17T12:51:34Z

⌛ Testing commit 8849d25 with merge ff768b4...

bors · 2023-10-17T13:42:32Z

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

Update cargo 17 commits in 6fa6fdc7606cfa664f9bee2fb33ee2ed904f4e88..ff768b45b302efd488178b31b35489e4fabb8799 2023-10-10 23:06:08 +0000 to 2023-10-17 12:51:31 +0000 - Clarify flag behavior in `cargo remove --help` (rust-lang/cargo#12823) - doc(cargo-login): mention args after `--` in manpage (rust-lang/cargo#12832) - changelog: add compat notice for `cargo login -- <arg>` (rust-lang/cargo#12830) - update SPDX License info (rust-lang/cargo#12827) - Add test for `-V` short argument (rust-lang/cargo#12822) - add detailed message when target folder path is invalid (rust-lang/cargo#12820) - chore(deps): update rust crate toml_edit to 0.20.2 (rust-lang/cargo#12761) - Support `public` dependency configuration with workspace deps (rust-lang/cargo#12817) - Update rustix to 0.38.18 (rust-lang/cargo#12815) - contrib docs: add some conveniences (rust-lang/cargo#12812) - Better suggestion for unsupported `--path` flag (rust-lang/cargo#12811) - contrib docs: update rfc and roadmap links (rust-lang/cargo#12814) - contrib doc: remove extraneous word (rust-lang/cargo#12813) - Update curl-sys to pull in curl 8.4.0 (rust-lang/cargo#12808) - feat: add package name and version to warning messages (rust-lang/cargo#12799) - Do not call it "Downgrading" when difference is only build metadata (rust-lang/cargo#12796) - Add unsupported short flag suggestion for `--target` and `--exclude` flags (rust-lang/cargo#12805) r? ghost

Update cargo 22 commits in 8eb8acbb116e7923ea2ce33a50109933ed5ab375..d2f6a048529eb8e9ebc55d793abd63456c98fac2 2023-10-17 11:55:04 +0000 to 2023-10-20 18:25:30 +0000 - chore(deps): bump rustix from 0.38.18 to 0.38.19 (rust-lang/cargo#12851) - refactor: centralize logic of getting max resolve version (rust-lang/cargo#12860) - If there's a version in the lock file only use that exact version (rust-lang/cargo#12772) - Make the precise field of a source an Enum (rust-lang/cargo#12849) - fix(cli): Provide next steps for bad -Z flag (rust-lang/cargo#12857) - fix(remove): Preserve feature comments (rust-lang/cargo#12837) - docs: fix typo (rust-lang/cargo#12844) - chore(triagebot): auto label when PR review state changes (rust-lang/cargo#12856) - fix(add): Preserve more comments (rust-lang/cargo#12838) - ci: big ⚠️ to ensure the CNAME file is always there (rust-lang/cargo#12853) - docs(cargo-bench): `--bench` is passed in unconditionally to bench harnesses (rust-lang/cargo#12850) - docs(contrib): generate redirection HTML pages in CI (rust-lang/cargo#12846) - docs: remove review capacity notice (rust-lang/cargo#12842) - fix(help):Clarify install's positional (rust-lang/cargo#12841) - Adjust `-Zcheck-cfg` for new rustc syntax and behavior (rust-lang/cargo#12845) - fix(replace): Partial-version spec support (rust-lang/cargo#12806) - Print environment variables for build script executions with `-vv` (rust-lang/cargo#12829) - fix(cli): Suggest cargo-search on bad commands (rust-lang/cargo#12840) - docs(contrib): Policy on manifest editing (rust-lang/cargo#12836) - ci/contrib: use separate concurrency group (rust-lang/cargo#12835) - ci/contrib: do not fail on missing gh-pages (rust-lang/cargo#12834) - Clarify flag behavior in `cargo remove --help` (rust-lang/cargo#12823) r? ghost

rustbot assigned weihanglo Oct 14, 2023

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

epage reviewed Oct 16, 2023

View reviewed changes

src/bin/cargo/commands/remove.rs Outdated Show resolved Hide resolved

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 Oct 16, 2023

epage changed the title ~~Fix typos in the remove command's help~~ Clarify flag behavior in cargo remove --help Oct 16, 2023

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

Update rm help to be specific about the section.

8849d25

Signed-off-by: David Calavera <david.calavera@gmail.com>

calavera force-pushed the fix_remove_help_typos branch from a8413d3 to 8849d25 Compare October 17, 2023 09:54

weihanglo approved these changes Oct 17, 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 Oct 17, 2023

bors merged commit ff768b4 into rust-lang:master Oct 17, 2023
20 checks passed

calavera deleted the fix_remove_help_typos branch October 17, 2023 13:49

weihanglo mentioned this pull request Oct 17, 2023

Update cargo rust-lang/rust#116844

Merged

weihanglo mentioned this pull request Oct 20, 2023

Update cargo rust-lang/rust#117000

Merged

ehuss added this to the 1.75.0 milestone Nov 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clarify flag behavior in `cargo remove --help` #12823

Clarify flag behavior in `cargo remove --help` #12823

calavera commented Oct 14, 2023

rustbot commented Oct 14, 2023

epage commented Oct 16, 2023

bors commented Oct 16, 2023

bors commented Oct 16, 2023

bors commented Oct 16, 2023

weihanglo commented Oct 16, 2023

calavera commented Oct 17, 2023

weihanglo commented Oct 17, 2023

bors commented Oct 17, 2023

bors commented Oct 17, 2023

bors commented Oct 17, 2023

Clarify flag behavior in cargo remove --help #12823

Clarify flag behavior in cargo remove --help #12823

Conversation

calavera commented Oct 14, 2023

What does this PR try to resolve?

How should we test and review this PR?

Additional information

rustbot commented Oct 14, 2023

epage commented Oct 16, 2023

bors commented Oct 16, 2023

bors commented Oct 16, 2023

bors commented Oct 16, 2023

weihanglo commented Oct 16, 2023

calavera commented Oct 17, 2023

weihanglo commented Oct 17, 2023

bors commented Oct 17, 2023

bors commented Oct 17, 2023

bors commented Oct 17, 2023

Clarify flag behavior in `cargo remove --help` #12823

Clarify flag behavior in `cargo remove --help` #12823