diff options
Diffstat (limited to 'src/tools/cargo/src/doc/src/commands/cargo-update.md')
-rw-r--r-- | src/tools/cargo/src/doc/src/commands/cargo-update.md | 197 |
1 files changed, 197 insertions, 0 deletions
diff --git a/src/tools/cargo/src/doc/src/commands/cargo-update.md b/src/tools/cargo/src/doc/src/commands/cargo-update.md new file mode 100644 index 000000000..3cfd69282 --- /dev/null +++ b/src/tools/cargo/src/doc/src/commands/cargo-update.md @@ -0,0 +1,197 @@ +# cargo-update(1) + +## NAME + +cargo-update --- Update dependencies as recorded in the local lock file + +## SYNOPSIS + +`cargo update` [_options_] + +## DESCRIPTION + +This command will update dependencies in the `Cargo.lock` file to the latest +version. If the `Cargo.lock` file does not exist, it will be created with the +latest available versions. + +## OPTIONS + +### Update Options + +<dl> + +<dt class="option-term" id="option-cargo-update--p"><a class="option-anchor" href="#option-cargo-update--p"></a><code>-p</code> <em>spec</em>…</dt> +<dt class="option-term" id="option-cargo-update---package"><a class="option-anchor" href="#option-cargo-update---package"></a><code>--package</code> <em>spec</em>…</dt> +<dd class="option-desc">Update only the specified packages. This flag may be specified +multiple times. See <a href="cargo-pkgid.html">cargo-pkgid(1)</a> for the SPEC format.</p> +<p>If packages are specified with the <code>-p</code> flag, then a conservative update of +the lockfile will be performed. This means that only the dependency specified +by SPEC will be updated. Its transitive dependencies will be updated only if +SPEC cannot be updated without updating dependencies. All other dependencies +will remain locked at their currently recorded versions.</p> +<p>If <code>-p</code> is not specified, all dependencies are updated.</dd> + + +<dt class="option-term" id="option-cargo-update---aggressive"><a class="option-anchor" href="#option-cargo-update---aggressive"></a><code>--aggressive</code></dt> +<dd class="option-desc">When used with <code>-p</code>, dependencies of <em>spec</em> are forced to update as well. +Cannot be used with <code>--precise</code>.</dd> + + +<dt class="option-term" id="option-cargo-update---precise"><a class="option-anchor" href="#option-cargo-update---precise"></a><code>--precise</code> <em>precise</em></dt> +<dd class="option-desc">When used with <code>-p</code>, 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).</dd> + + +<dt class="option-term" id="option-cargo-update--w"><a class="option-anchor" href="#option-cargo-update--w"></a><code>-w</code></dt> +<dt class="option-term" id="option-cargo-update---workspace"><a class="option-anchor" href="#option-cargo-update---workspace"></a><code>--workspace</code></dt> +<dd class="option-desc">Attempt to update only packages defined in the workspace. Other packages +are updated only if they don’t already exist in the lockfile. This +option is useful for updating <code>Cargo.lock</code> after you’ve changed version +numbers in <code>Cargo.toml</code>.</dd> + + +<dt class="option-term" id="option-cargo-update---dry-run"><a class="option-anchor" href="#option-cargo-update---dry-run"></a><code>--dry-run</code></dt> +<dd class="option-desc">Displays what would be updated, but doesn’t actually write the lockfile.</dd> + + +</dl> + +### Display Options + +<dl> +<dt class="option-term" id="option-cargo-update--v"><a class="option-anchor" href="#option-cargo-update--v"></a><code>-v</code></dt> +<dt class="option-term" id="option-cargo-update---verbose"><a class="option-anchor" href="#option-cargo-update---verbose"></a><code>--verbose</code></dt> +<dd class="option-desc">Use verbose output. May be specified twice for “very verbose” output which +includes extra output such as dependency warnings and build script output. +May also be specified with the <code>term.verbose</code> +<a href="../reference/config.html">config value</a>.</dd> + + +<dt class="option-term" id="option-cargo-update--q"><a class="option-anchor" href="#option-cargo-update--q"></a><code>-q</code></dt> +<dt class="option-term" id="option-cargo-update---quiet"><a class="option-anchor" href="#option-cargo-update---quiet"></a><code>--quiet</code></dt> +<dd class="option-desc">Do not print cargo log messages. +May also be specified with the <code>term.quiet</code> +<a href="../reference/config.html">config value</a>.</dd> + + +<dt class="option-term" id="option-cargo-update---color"><a class="option-anchor" href="#option-cargo-update---color"></a><code>--color</code> <em>when</em></dt> +<dd class="option-desc">Control when colored output is used. Valid values:</p> +<ul> +<li><code>auto</code> (default): Automatically detect if color support is available on the +terminal.</li> +<li><code>always</code>: Always display colors.</li> +<li><code>never</code>: Never display colors.</li> +</ul> +<p>May also be specified with the <code>term.color</code> +<a href="../reference/config.html">config value</a>.</dd> + + +</dl> + +### Manifest Options + +<dl> + +<dt class="option-term" id="option-cargo-update---manifest-path"><a class="option-anchor" href="#option-cargo-update---manifest-path"></a><code>--manifest-path</code> <em>path</em></dt> +<dd class="option-desc">Path to the <code>Cargo.toml</code> file. By default, Cargo searches for the +<code>Cargo.toml</code> file in the current directory or any parent directory.</dd> + + + +<dt class="option-term" id="option-cargo-update---frozen"><a class="option-anchor" href="#option-cargo-update---frozen"></a><code>--frozen</code></dt> +<dt class="option-term" id="option-cargo-update---locked"><a class="option-anchor" href="#option-cargo-update---locked"></a><code>--locked</code></dt> +<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is +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> +<p>These may be used in environments where you want to assert that the +<code>Cargo.lock</code> file is up-to-date (such as a CI build) or want to avoid network +access.</dd> + + +<dt class="option-term" id="option-cargo-update---offline"><a class="option-anchor" href="#option-cargo-update---offline"></a><code>--offline</code></dt> +<dd class="option-desc">Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible.</p> +<p>Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the <a href="cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going +offline.</p> +<p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</dd> + + + +</dl> + +### Common Options + +<dl> + +<dt class="option-term" id="option-cargo-update-+toolchain"><a class="option-anchor" href="#option-cargo-update-+toolchain"></a><code>+</code><em>toolchain</em></dt> +<dd class="option-desc">If Cargo has been installed with rustup, and the first argument to <code>cargo</code> +begins with <code>+</code>, it will be interpreted as a rustup toolchain name (such +as <code>+stable</code> or <code>+nightly</code>). +See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup documentation</a> +for more information about how toolchain overrides work.</dd> + + +<dt class="option-term" id="option-cargo-update---config"><a class="option-anchor" href="#option-cargo-update---config"></a><code>--config</code> <em>KEY=VALUE</em> or <em>PATH</em></dt> +<dd class="option-desc">Overrides a Cargo configuration value. The argument should be in TOML syntax of <code>KEY=VALUE</code>, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the <a href="../reference/config.html#command-line-overrides">command-line overrides section</a> for more information.</dd> + + +<dt class="option-term" id="option-cargo-update--C"><a class="option-anchor" href="#option-cargo-update--C"></a><code>-C</code> <em>PATH</em></dt> +<dd class="option-desc">Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (<code>Cargo.toml</code>), as well as +the directories searched for discovering <code>.cargo/config.toml</code>, for example. This option must +appear before the command name, for example <code>cargo -C path/to/my-project build</code>.</p> +<p>This option is only available on the <a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly +channel</a> and +requires the <code>-Z unstable-options</code> flag to enable (see +<a href="https://github.com/rust-lang/cargo/issues/10098">#10098</a>).</dd> + + +<dt class="option-term" id="option-cargo-update--h"><a class="option-anchor" href="#option-cargo-update--h"></a><code>-h</code></dt> +<dt class="option-term" id="option-cargo-update---help"><a class="option-anchor" href="#option-cargo-update---help"></a><code>--help</code></dt> +<dd class="option-desc">Prints help information.</dd> + + +<dt class="option-term" id="option-cargo-update--Z"><a class="option-anchor" href="#option-cargo-update--Z"></a><code>-Z</code> <em>flag</em></dt> +<dd class="option-desc">Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</dd> + + +</dl> + + +## ENVIRONMENT + +See [the reference](../reference/environment-variables.html) for +details on environment variables that Cargo reads. + + +## EXIT STATUS + +* `0`: Cargo succeeded. +* `101`: Cargo failed to complete. + + +## EXAMPLES + +1. Update all dependencies in the lockfile: + + cargo update + +2. Update only specific dependencies: + + cargo update -p foo -p bar + +3. Set a specific dependency to a specific version: + + cargo update -p foo --precise 1.2.3 + +## SEE ALSO +[cargo(1)](cargo.html), [cargo-generate-lockfile(1)](cargo-generate-lockfile.html) |