Skip to content

Change argument name to --precise option in cargo update. #16283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SebastianJL wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Change argument name to --precise option in cargo update. #16283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Cannot be used with <code>--precise</code>.</p>
</dd>


<dt class="option-term" id="option-cargo-update---precise"><a class="option-anchor" href="#option-cargo-update---precise"><code>--precise</code> <em>precise</em></a></dt>
<dt class="option-term" id="option-cargo-update---precise"><a class="option-anchor" href="#option-cargo-update---precise"><code>--precise</code> <em>version</em></a></dt>
Copy link
Contributor

@epage epage Nov 21, 2025

Choose a reason for hiding this comment

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

You need to run cargo build-man

Copy link
Contributor

@epage epage Nov 21, 2025

Choose a reason for hiding this comment

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

If we change it here, we should also change it in cargo update -h

Copy link
Contributor

@epage epage Nov 21, 2025

Choose a reason for hiding this comment

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

This isn't just a version. It can also be a git commit sha

Copy link
Author

@SebastianJL SebastianJL Nov 21, 2025

Choose a reason for hiding this comment

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

Do you have a suggestion for a better wording? It sure is better than "precise".

Copy link
Contributor

@epage epage Nov 21, 2025

Choose a reason for hiding this comment

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

VERSION|REV at least works in -h. Unsure if we should do similar in man (version|rev); I'm not seeing any precedence for | in value names within Cargo. Also, odd that they are inconsistent in casing.

Copy link
Member

@weihanglo weihanglo Nov 21, 2025

Choose a reason for hiding this comment

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

I don't feel like version is better than precise. It implies a version, which people will stop reading and don't know it accept Git revision. At least precise is ambiguous enough that people may dig deeper.

I'm not seeing any precedence for

--config has that:

--config KEY=VALUE or PATH

Copy link
Contributor

@epage epage Nov 21, 2025

Choose a reason for hiding this comment

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

--config has that:

Thanks! I had limited my search to src/bin/cargo/commands and so ahd missed that we did KEY=VALUE|PATH there.

Copy link
Contributor

@epage epage Nov 21, 2025

Choose a reason for hiding this comment

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

... and of course the man page is inconsistent on SCREAMING or lower case.

<dd class="option-desc"><p>When used with <em>spec</em>, allows you to specify a specific version number to set
the package to. If the package comes from a git repository, this can be a git
revision (such as a SHA hash or tag).</p>
Expand Down
Loading