From 7c9f45b3723e8ecc251e08adbe04e62ca2bf9094 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Sat, 26 Sep 2020 09:59:43 -0700 Subject: [PATCH] Fix minor error in `cargo update` docs. --- src/doc/man/cargo-generate-lockfile.md | 4 ++-- src/doc/man/cargo-update.md | 4 ++-- src/doc/man/generated_txt/cargo-generate-lockfile.txt | 4 ++-- src/doc/man/generated_txt/cargo-update.txt | 5 ++--- src/doc/src/commands/cargo-generate-lockfile.md | 4 ++-- src/doc/src/commands/cargo-update.md | 4 ++-- src/etc/man/cargo-generate-lockfile.1 | 4 ++-- src/etc/man/cargo-update.1 | 4 ++-- 8 files changed, 16 insertions(+), 17 deletions(-) diff --git a/src/doc/man/cargo-generate-lockfile.md b/src/doc/man/cargo-generate-lockfile.md index 2bc1828e488..a2b963cef44 100644 --- a/src/doc/man/cargo-generate-lockfile.md +++ b/src/doc/man/cargo-generate-lockfile.md @@ -11,8 +11,8 @@ cargo-generate-lockfile - Generate the lockfile for a package ## DESCRIPTION This command will create the `Cargo.lock` lockfile for the current package or -workspace. If the lockfile already exists, it will be rebuilt if there are any -manifest changes or dependency updates. +workspace. If the lockfile already exists, it will be rebuilt with the latest +available version of every package. See also {{man "cargo-update" 1}} which is also capable of creating a `Cargo.lock` lockfile and has more options for controlling update behavior. diff --git a/src/doc/man/cargo-update.md b/src/doc/man/cargo-update.md index db0210b8bfe..3bca1982c66 100644 --- a/src/doc/man/cargo-update.md +++ b/src/doc/man/cargo-update.md @@ -11,8 +11,8 @@ cargo-update - Update dependencies as recorded in the local lock file ## DESCRIPTION This command will update dependencies in the `Cargo.lock` file to the latest -version. It requires that the `Cargo.lock` file already exists as generated -by commands such as {{man "cargo-build" 1}} or {{man "cargo-generate-lockfile" 1}}. +version. If the `Cargo.lock` file does not exist, it will be created with the +latest available versions. ## OPTIONS diff --git a/src/doc/man/generated_txt/cargo-generate-lockfile.txt b/src/doc/man/generated_txt/cargo-generate-lockfile.txt index 5ef41c05dec..6f02231b9ca 100644 --- a/src/doc/man/generated_txt/cargo-generate-lockfile.txt +++ b/src/doc/man/generated_txt/cargo-generate-lockfile.txt @@ -8,8 +8,8 @@ SYNOPSIS DESCRIPTION This command will create the Cargo.lock lockfile for the current package - or workspace. If the lockfile already exists, it will be rebuilt if - there are any manifest changes or dependency updates. + or workspace. If the lockfile already exists, it will be rebuilt with + the latest available version of every package. See also cargo-update(1) which is also capable of creating a Cargo.lock lockfile and has more options for controlling update behavior. diff --git a/src/doc/man/generated_txt/cargo-update.txt b/src/doc/man/generated_txt/cargo-update.txt index 0088515fea8..6e2d95ad488 100644 --- a/src/doc/man/generated_txt/cargo-update.txt +++ b/src/doc/man/generated_txt/cargo-update.txt @@ -8,9 +8,8 @@ SYNOPSIS DESCRIPTION This command will update dependencies in the Cargo.lock file to the - latest version. It requires that the Cargo.lock file already exists as - generated by commands such as cargo-build(1) or - cargo-generate-lockfile(1). + latest version. If the Cargo.lock file does not exist, it will be + created with the latest available versions. OPTIONS Update Options diff --git a/src/doc/src/commands/cargo-generate-lockfile.md b/src/doc/src/commands/cargo-generate-lockfile.md index 79b1decc04e..7a60dfc19d1 100644 --- a/src/doc/src/commands/cargo-generate-lockfile.md +++ b/src/doc/src/commands/cargo-generate-lockfile.md @@ -11,8 +11,8 @@ cargo-generate-lockfile - Generate the lockfile for a package ## DESCRIPTION This command will create the `Cargo.lock` lockfile for the current package or -workspace. If the lockfile already exists, it will be rebuilt if there are any -manifest changes or dependency updates. +workspace. If the lockfile already exists, it will be rebuilt with the latest +available version of every package. See also [cargo-update(1)](cargo-update.md) which is also capable of creating a `Cargo.lock` lockfile and has more options for controlling update behavior. diff --git a/src/doc/src/commands/cargo-update.md b/src/doc/src/commands/cargo-update.md index c07bf49c73b..5ac48d49906 100644 --- a/src/doc/src/commands/cargo-update.md +++ b/src/doc/src/commands/cargo-update.md @@ -11,8 +11,8 @@ cargo-update - Update dependencies as recorded in the local lock file ## DESCRIPTION This command will update dependencies in the `Cargo.lock` file to the latest -version. It requires that the `Cargo.lock` file already exists as generated -by commands such as [cargo-build(1)](cargo-build.md) or [cargo-generate-lockfile(1)](cargo-generate-lockfile.md). +version. If the `Cargo.lock` file does not exist, it will be created with the +latest available versions. ## OPTIONS diff --git a/src/etc/man/cargo-generate-lockfile.1 b/src/etc/man/cargo-generate-lockfile.1 index 8e714a0d5da..4e36e2e039a 100644 --- a/src/etc/man/cargo-generate-lockfile.1 +++ b/src/etc/man/cargo-generate-lockfile.1 @@ -9,8 +9,8 @@ cargo\-generate\-lockfile \- Generate the lockfile for a package \fBcargo generate\-lockfile\fR [\fIoptions\fR] .SH "DESCRIPTION" This command will create the \fBCargo.lock\fR lockfile for the current package or -workspace. If the lockfile already exists, it will be rebuilt if there are any -manifest changes or dependency updates. +workspace. If the lockfile already exists, it will be rebuilt with the latest +available version of every package. .sp See also \fBcargo\-update\fR(1) which is also capable of creating a \fBCargo.lock\fR lockfile and has more options for controlling update behavior. diff --git a/src/etc/man/cargo-update.1 b/src/etc/man/cargo-update.1 index 0cf6cf2b0f8..970ade7118d 100644 --- a/src/etc/man/cargo-update.1 +++ b/src/etc/man/cargo-update.1 @@ -9,8 +9,8 @@ cargo\-update \- Update dependencies as recorded in the local lock file \fBcargo update\fR [\fIoptions\fR] .SH "DESCRIPTION" This command will update dependencies in the \fBCargo.lock\fR file to the latest -version. It requires that the \fBCargo.lock\fR file already exists as generated -by commands such as \fBcargo\-build\fR(1) or \fBcargo\-generate\-lockfile\fR(1). +version. If the \fBCargo.lock\fR file does not exist, it will be created with the +latest available versions. .SH "OPTIONS" .SS "Update Options" .sp