Skip to content

Commit

Permalink
Auto merge of #8737 - ehuss:doc-update-lockfile, r=alexcrichton
Browse files Browse the repository at this point in the history
Fix minor error in `cargo update` docs.

`cargo update` does not require `Cargo.lock` to exist.

Also updated `generate-lockfile` to maybe be a little clearer (to me).
  • Loading branch information
bors committed Sep 27, 2020
2 parents 05c611a + 7c9f45b commit 8835604
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 17 deletions.
4 changes: 2 additions & 2 deletions src/doc/man/cargo-generate-lockfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/cargo-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/doc/man/generated_txt/cargo-generate-lockfile.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 2 additions & 3 deletions src/doc/man/generated_txt/cargo-update.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-generate-lockfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/doc/src/commands/cargo-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/etc/man/cargo-generate-lockfile.1
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/etc/man/cargo-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 8835604

Please sign in to comment.