docs: remove stray directory metavar from cargo update --breaking option - #17319
Merged
Merged
Conversation
rustbot
added
A-cli-help
Collaborator
|
Thanks for the pull request, and welcome! The Rust Project is excited to review your changes, and you should hear from @epage (or someone else) some time within the next two weeks. 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 (
Why was this reviewer chosen?The reviewer was selected based on:
|
This comment has been minimized.
This comment has been minimized.
GuTS805
force-pushed
the
fix/cargo-update-breaking-doc
branch
from
August 5, 2026 22:33
dd13237 to
d2960f8
Compare
Collaborator
|
This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
weihanglo
approved these changes
Aug 5, 2026
weihanglo
enabled auto-merge
August 5, 2026 23:10
Contributor
Author
|
Thanks for the review |
rustbot
removed
the
S-waiting-on-review
rust-bors Bot
pushed a commit
to rust-lang/rust
that referenced
this pull request
Aug 8, 2026
Update cargo submodule 14 commits in c79e8f89441b3e73d6d65d125c0c745792808c74..b07e5a08651da80108eb65d7dc769ee04589f9bf 2026-08-04 19:17:33 +0000 to 2026-08-07 21:51:16 +0000 - feat(profile): Add built-in profile debug (rust-lang/cargo#17214) - feat(toml): allow overriding inherited default-features in 2024 (rust-lang/cargo#17126) - feat(resolver): Report the min-publish-age in the lock message (rust-lang/cargo#17328) - refactor(resolver): resolve() does not need an optional gctx (rust-lang/cargo#17331) - fix(resolver): Make min-publish-age relative to --publish-time (rust-lang/cargo#17327) - test(trim-paths): exercise unremap files with debuggers (rust-lang/cargo#17326) - feat(log): emit build-started JSON message with run_id (rust-lang/cargo#16632) - docs: remove stray `directory` metavar from `cargo update --breaking` option (rust-lang/cargo#17319) - fix(lock): Use more accurate 'highest, rather than 'latest' (rust-lang/cargo#17317) - docs(changelog): Pull the --verbose item (rust-lang/cargo#17315) - revert(compiler): forward verbose flag to rustc for local crates (rust-lang/cargo#17314) - fix(diag): Gate blanket_hint_mostly_unused with -Zprofile-hint-mostly-unused (rust-lang/cargo#17313) - fix(diag): Remove complexity, perf, and nursery lint groups (rust-lang/cargo#17307) - fix(git): Avoid use of git's core.fsmonitor (rust-lang/cargo#17306) r? ghost
pull Bot
pushed a commit
to LeeeeeeM/miri
that referenced
this pull request
Aug 9, 2026
Update cargo submodule 14 commits in c79e8f89441b3e73d6d65d125c0c745792808c74..b07e5a08651da80108eb65d7dc769ee04589f9bf 2026-08-04 19:17:33 +0000 to 2026-08-07 21:51:16 +0000 - feat(profile): Add built-in profile debug (rust-lang/cargo#17214) - feat(toml): allow overriding inherited default-features in 2024 (rust-lang/cargo#17126) - feat(resolver): Report the min-publish-age in the lock message (rust-lang/cargo#17328) - refactor(resolver): resolve() does not need an optional gctx (rust-lang/cargo#17331) - fix(resolver): Make min-publish-age relative to --publish-time (rust-lang/cargo#17327) - test(trim-paths): exercise unremap files with debuggers (rust-lang/cargo#17326) - feat(log): emit build-started JSON message with run_id (rust-lang/cargo#16632) - docs: remove stray `directory` metavar from `cargo update --breaking` option (rust-lang/cargo#17319) - fix(lock): Use more accurate 'highest, rather than 'latest' (rust-lang/cargo#17317) - docs(changelog): Pull the --verbose item (rust-lang/cargo#17315) - revert(compiler): forward verbose flag to rustc for local crates (rust-lang/cargo#17314) - fix(diag): Gate blanket_hint_mostly_unused with -Zprofile-hint-mostly-unused (rust-lang/cargo#17313) - fix(diag): Remove complexity, perf, and nursery lint groups (rust-lang/cargo#17307) - fix(git): Avoid use of git's core.fsmonitor (rust-lang/cargo#17306) r? ghost
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
What does this PR try to resolve?
The
--breakingoption incargo updateis documented as taking adirectoryargument:This is incorrect —
--breakingis a plain boolean flag with no argument. It's defined via theflag(...)helper insrc/bin/cargo/commands/update.rsand checked withargs.flag("breaking"), the same pattern used by--recursive/--dry-run, which correctly show no metavar. Runningcargo update --helpconfirms this:The stray
_directory_appears to be a copy-paste artifact from other flags that legitimately take a directory value (e.g.--artifact-dir,--target-dir), most likely introduced when--breakingwas added in #13979.This PR removes the incorrect metavar from the doc/man source (
doc/man/cargo-update.md) and regenerates the derived outputs (doc/man/generated_txt/cargo-update.txt,etc/man/cargo-update.1,doc/book/src/commands/cargo-update.md) viacargo build-man, per the documentation contributor guide.How to test and review this PR?
Compare the rendered
--breakingentry before/after indoc/man/generated_txt/cargo-update.txtordoc/book/src/commands/cargo-update.md— it should no longer showdirectoryafter--breaking. This is a docs-only change; no behavior is affected.Fixes #17318