Skip to content

docs: remove stray directory metavar from cargo update --breaking option - #17319

Merged
weihanglo merged 1 commit into
rust-lang:masterfrom
GuTS805:fix/cargo-update-breaking-doc
Aug 5, 2026
Merged

docs: remove stray directory metavar from cargo update --breaking option#17319
weihanglo merged 1 commit into
rust-lang:masterfrom
GuTS805:fix/cargo-update-breaking-doc

Conversation

@GuTS805

@GuTS805 GuTS805 commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

What does this PR try to resolve?

The --breaking option in cargo update is documented as taking a directory argument:

--breaking directory
    Update spec to latest SemVer-breaking version.

This is incorrect — --breaking is a plain boolean flag with no argument. It's defined via the flag(...) helper in src/bin/cargo/commands/update.rs and checked with args.flag("breaking"), the same pattern used by --recursive/--dry-run, which correctly show no metavar. Running cargo update --help confirms this:

-b, --breaking  Update [SPEC] to latest SemVer-breaking version (unstable)

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 --breaking was 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) via cargo build-man, per the documentation contributor guide.

How to test and review this PR?

Compare the rendered --breaking entry before/after in doc/man/generated_txt/cargo-update.txt or doc/book/src/commands/cargo-update.md — it should no longer show directory after --breaking. This is a docs-only change; no behavior is affected.

Fixes #17318

@rustbot rustbot added A-cli-help Area: built-in command-line help A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 5, 2026
@rustbot

rustbot commented Aug 5, 2026

Copy link
Copy Markdown
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 (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
Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: @epage, @weihanglo
  • @epage, @weihanglo expanded to epage, weihanglo
  • Random selection from epage, weihanglo

@rustbot

This comment has been minimized.

@GuTS805
GuTS805 force-pushed the fix/cargo-update-breaking-doc branch from dd13237 to d2960f8 Compare August 5, 2026 22:33
@rustbot

rustbot commented Aug 5, 2026

Copy link
Copy Markdown
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 weihanglo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weihanglo
weihanglo enabled auto-merge August 5, 2026 23:10
@weihanglo
weihanglo added this pull request to the merge queue Aug 5, 2026
@GuTS805

GuTS805 commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review

Merged via the queue into rust-lang:master with commit 0e07a15 Aug 5, 2026
29 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 5, 2026
@GuTS805
GuTS805 deleted the fix/cargo-update-breaking-doc branch August 5, 2026 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-cli-help Area: built-in command-line help A-documenting-cargo-itself Area: Cargo's documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc: cargo update --breaking shows a stray directory argument in its option heading

4 participants