Change argument name to --precise option in cargo update. #16283
Conversation
The argument is currently named `precise` which doesn't really make sense. Therefore it's changed to `version` because a version is what needs to specified.
rustbot
added
A-documenting-cargo-itself
|
|
||
|
|
||
| <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> |
There was a problem hiding this comment.
You need to run cargo build-man
|
|
||
|
|
||
| <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> |
There was a problem hiding this comment.
If we change it here, we should also change it in cargo update -h
|
|
||
|
|
||
| <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> |
There was a problem hiding this comment.
This isn't just a version. It can also be a git commit sha
There was a problem hiding this comment.
Do you have a suggestion for a better wording? It sure is better than "precise".
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
--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.
There was a problem hiding this comment.
... and of course the man page is inconsistent on SCREAMING or lower case.
4 participants
What does this PR try to resolve?
The argument of the
cargo updateflag--preciseis currently also namedprecisein the docs. This doesn't really make sense. Therefore it's changed toversionbecause a version is what needs to specified.How to test and review this PR?
No tests needed.