Skip to content
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.

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

chore: Fix minor grammar nit in command-line help #13602

Merged
merged 1 commit into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions crates/xtask-bump-check/src/xtask.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ pub fn cli() -> clap::Command {
)
.arg(opt("base-rev", "Git revision to lookup for a baseline"))
.arg(opt("head-rev", "Git revision with changes"))
.arg(flag("frozen", "Require Cargo.lock and cache are up to date").global(true))
.arg(flag("locked", "Require Cargo.lock is up to date").global(true))
.arg(flag("frozen", "Require Cargo.lock and cache to be up-to-date").global(true))
.arg(flag("locked", "Require Cargo.lock to be up-to-date").global(true))
.arg(flag("offline", "Run without accessing the network").global(true))
.arg(multi_opt("config", "KEY=VALUE", "Override a configuration value").global(true))
.arg(
Expand Down
4 changes: 2 additions & 2 deletions src/bin/cargo/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -640,12 +640,12 @@ See '<cyan,bold>cargo help</> <cyan><<command>></>' for more information on a sp
.value_parser(clap::builder::ValueParser::path_buf()),
)
.arg(
flag("frozen", "Require Cargo.lock and cache are up to date")
flag("frozen", "Require Cargo.lock and cache to be up-to-date")
.help_heading(heading::MANIFEST_OPTIONS)
.global(true),
)
.arg(
flag("locked", "Require Cargo.lock is up to date")
flag("locked", "Require Cargo.lock to be up-to-date")
.help_heading(heading::MANIFEST_OPTIONS)
.global(true),
)
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-add.txt
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ OPTIONS
Add dependencies to only the specified package.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-bench.txt
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-build.txt
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-check.txt
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-clean.txt
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-fetch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-fix.txt
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-generate-lockfile.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ OPTIONS

Manifest Options
--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-metadata.txt
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-package.txt
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-pkgid.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-publish.txt
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-remove.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-run.txt
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-rustc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-rustdoc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-tree.txt
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-update.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-vendor.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/generated_txt/cargo-verify-project.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ OPTIONS
Cargo.toml file in the current directory or any parent directory.

--frozen, --locked
Either of these flags requires that the Cargo.lock file is
Either of these flags requires that the Cargo.lock file be
up-to-date. If the lock file is missing, or it needs to be updated,
Cargo will exit with an error. The --frozen flag also prevents Cargo
from attempting to access the network to determine if it is
Expand Down
2 changes: 1 addition & 1 deletion src/doc/man/includes/options-locked.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{#option "`--frozen`" "`--locked`"}}
Either of these flags requires that the `Cargo.lock` file is
Either of these flags requires that the `Cargo.lock` file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The `--frozen` flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ terminal.</li>

<dt class="option-term" id="option-cargo-add---frozen"><a class="option-anchor" href="#option-cargo-add---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-add---locked"><a class="option-anchor" href="#option-cargo-add---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-bench.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ coming from rustc are still emitted. Cannot be used with <code>human</code> or <

<dt class="option-term" id="option-cargo-bench---frozen"><a class="option-anchor" href="#option-cargo-bench---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-bench---locked"><a class="option-anchor" href="#option-cargo-bench---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ See <a href="https://github.com/rust-lang/cargo/issues/5579">https://github.com/

<dt class="option-term" id="option-cargo-build---frozen"><a class="option-anchor" href="#option-cargo-build---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-build---locked"><a class="option-anchor" href="#option-cargo-build---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ coming from rustc are still emitted. Cannot be used with <code>human</code> or <

<dt class="option-term" id="option-cargo-check---frozen"><a class="option-anchor" href="#option-cargo-check---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-check---locked"><a class="option-anchor" href="#option-cargo-check---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ terminal.</li>

<dt class="option-term" id="option-cargo-clean---frozen"><a class="option-anchor" href="#option-cargo-clean---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-clean---locked"><a class="option-anchor" href="#option-cargo-clean---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ coming from rustc are still emitted. Cannot be used with <code>human</code> or <

<dt class="option-term" id="option-cargo-doc---frozen"><a class="option-anchor" href="#option-cargo-doc---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-doc---locked"><a class="option-anchor" href="#option-cargo-doc---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ terminal.</li>

<dt class="option-term" id="option-cargo-fetch---frozen"><a class="option-anchor" href="#option-cargo-fetch---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-fetch---locked"><a class="option-anchor" href="#option-cargo-fetch---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/doc/src/commands/cargo-fix.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ coming from rustc are still emitted. Cannot be used with <code>human</code> or <

<dt class="option-term" id="option-cargo-fix---frozen"><a class="option-anchor" href="#option-cargo-fix---frozen"></a><code>--frozen</code></dt>
<dt class="option-term" id="option-cargo-fix---locked"><a class="option-anchor" href="#option-cargo-fix---locked"></a><code>--locked</code></dt>
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is
<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file be
up-to-date. If the lock file is missing, or it needs to be updated, Cargo will
exit with an error. The <code>--frozen</code> flag also prevents Cargo from
attempting to access the network to determine if it is out-of-date.</p>
Expand Down
Loading