Document cargo remove
#11227
Document cargo remove
#11227
Conversation
|
r? @epage (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
cassaundra
force-pushed
the
remove-docs
branch
from
64ca44e to
74b29d2
Compare
|
@bors r+ |
bors
added
S-waiting-on-bors
Document `cargo remove` ### What does this PR try to resolve? This PR continues the deferred work of #11099 by adding documentation for the cargo remove subcommand. ### How should we test and review this PR? Ensure that the documentation renders correctly and appropriately covers the feature.
|
Not sure what that failing test is about. I suppose I'll just rebase to master and hope that resolves it. |
|
sigh new clap release changed some things we validate but we don't keep a lockfile for our own purposes (we are part of the rust-lang/rust workspace) I'll get the tests fixed |
|
💔 Test failed - checks-actions |
bors
added
S-waiting-on-review
|
@bors r+ |
|
💡 This pull request was already approved, no need to approve it again.
|
bors
added
S-waiting-on-bors
Document `cargo remove` ### What does this PR try to resolve? This PR continues the deferred work of #11099 by adding documentation for the cargo remove subcommand. ### How should we test and review this PR? Ensure that the documentation renders correctly and appropriately covers the feature.
cassaundra
force-pushed
the
remove-docs
branch
from
74b29d2 to
babdd63
Compare
There was a problem hiding this comment.
Can you also make sure that the https://github.com/rust-lang/cargo/blob/master/src/doc/src/commands/manifest-commands.md index is updated?
| {{#options}} | ||
| {{> options-manifest-path }} | ||
|
|
||
| {{> options-locked }} |
There was a problem hiding this comment.
Although cargo rm technically accepts --locked/--frozen, I don't think it should be documented here because it prevents cargo rm from working. It is somewhat a bug that --locked/--frozen are global flags. They should have been added on a per-command basis, but that may be difficult to fix now.
This may require separating --offline from options-locked.md so that it can be kept. (See also #11237)
There was a problem hiding this comment.
I can certainly move --offline from options-locked.md to resolve that. Is that something you'd like in a separate PR?
Ideally I imagine we'd make that change at the same time we make --locked/--frozen not global, so that the problem is fixed and documentation is correctly maintained, but maybe that's not a problem worth solving right now.
There was a problem hiding this comment.
side note: I think whatever we do, the shell completions should match the docs (see #11204)
There was a problem hiding this comment.
Is that something you'd like in a separate PR?
Either here or separate is fine with me. Maybe separate might be better if it involves changing a lot of files?
cassaundra
force-pushed
the
remove-docs
branch
from
babdd63 to
9bacebf
Compare
Done. |
|
Since it sounds like the only remaining issue is going to be split into a separate PR, I'm going ahead and merging this. @bors r+ |
|
☀️ Test successful - checks-actions |
6 commits in b332991a57c9d055f1864de1eed93e2178d49440..3ff044334f0567ce1481c78603aeee7211b91623 2022-10-13 22:05:28 +0000 to 2022-10-17 20:25:00 +0000 - Some tiny refactors around `ops::cargo_compile` (rust-lang/cargo#11243) - Polish docs for module `build_context` (rust-lang/cargo#11241) - Remove sparse+ prefix for index.crates.io (rust-lang/cargo#11247) - docs(add): Add missing flags to reference (rust-lang/cargo#11240) - Document `cargo remove` (rust-lang/cargo#11227) - fix: Update help headings to match clap (rust-lang/cargo#11239)
Update cargo 6 commits in b332991a57c9d055f1864de1eed93e2178d49440..3ff044334f0567ce1481c78603aeee7211b91623 2022-10-13 22:05:28 +0000 to 2022-10-17 20:25:00 +0000 - Some tiny refactors around `ops::cargo_compile` (rust-lang/cargo#11243) - Polish docs for module `build_context` (rust-lang/cargo#11241) - Remove sparse+ prefix for index.crates.io (rust-lang/cargo#11247) - docs(add): Add missing flags to reference (rust-lang/cargo#11240) - Document `cargo remove` (rust-lang/cargo#11227) - fix: Update help headings to match clap (rust-lang/cargo#11239)
What does this PR try to resolve?
This PR continues the deferred work of #11099 by adding documentation for the cargo remove subcommand.
How should we test and review this PR?
Ensure that the documentation renders correctly and appropriately covers the feature.