From 662394e10f43441396167cc6345d3da573dc3521 Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Tue, 14 Jan 2025 20:48:45 -0500 Subject: [PATCH] docs(cargo-package): alwasy include the lockfile This was overlooked in #14815. --- src/doc/man/cargo-package.md | 6 +++--- src/doc/man/generated_txt/cargo-package.txt | 6 +++--- src/doc/src/commands/cargo-package.md | 6 +++--- src/etc/man/cargo-package.1 | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/doc/man/cargo-package.md b/src/doc/man/cargo-package.md index 9d691c12b96..986fb0b4c57 100644 --- a/src/doc/man/cargo-package.md +++ b/src/doc/man/cargo-package.md @@ -26,9 +26,9 @@ stored in the `target/package` directory. This performs the following steps: - The original `Cargo.toml` file is rewritten and normalized. - `[patch]`, `[replace]`, and `[workspace]` sections are removed from the manifest. - - `Cargo.lock` is automatically included if the package contains an - executable binary or example target. {{man "cargo-install" 1}} will use the - packaged lock file if the `--locked` flag is used. + - `Cargo.lock` is always included. When missing, a new lock file will be + generated. {{man "cargo-install" 1}} will use the packaged lock file if + the `--locked` flag is used. - A `.cargo_vcs_info.json` file is included that contains information about the current VCS checkout hash if available, as well as a flag if the worktree is dirty. diff --git a/src/doc/man/generated_txt/cargo-package.txt b/src/doc/man/generated_txt/cargo-package.txt index d7265289ce5..421613b17f6 100644 --- a/src/doc/man/generated_txt/cargo-package.txt +++ b/src/doc/man/generated_txt/cargo-package.txt @@ -26,9 +26,9 @@ DESCRIPTION o [patch], [replace], and [workspace] sections are removed from the manifest. - o Cargo.lock is automatically included if the package contains an - executable binary or example target. cargo-install(1) will use the - packaged lock file if the --locked flag is used. + o Cargo.lock is always included. When missing, a new lock file will + be generated. cargo-install(1) will use the packaged lock file if + the --locked flag is used. o A .cargo_vcs_info.json file is included that contains information about the current VCS checkout hash if available, as well as a diff --git a/src/doc/src/commands/cargo-package.md b/src/doc/src/commands/cargo-package.md index d50af10f411..6e2a40fede9 100644 --- a/src/doc/src/commands/cargo-package.md +++ b/src/doc/src/commands/cargo-package.md @@ -21,9 +21,9 @@ stored in the `target/package` directory. This performs the following steps: - The original `Cargo.toml` file is rewritten and normalized. - `[patch]`, `[replace]`, and `[workspace]` sections are removed from the manifest. - - `Cargo.lock` is automatically included if the package contains an - executable binary or example target. [cargo-install(1)](cargo-install.html) will use the - packaged lock file if the `--locked` flag is used. + - `Cargo.lock` is always included. When missing, a new lock file will be + generated. [cargo-install(1)](cargo-install.html) will use the packaged lock file if + the `--locked` flag is used. - A `.cargo_vcs_info.json` file is included that contains information about the current VCS checkout hash if available, as well as a flag if the worktree is dirty. diff --git a/src/etc/man/cargo-package.1 b/src/etc/man/cargo-package.1 index 9f124d96a4b..7917bab7b25 100644 --- a/src/etc/man/cargo-package.1 +++ b/src/etc/man/cargo-package.1 @@ -35,9 +35,9 @@ manifest. .RE .sp .RS 4 -\h'-04'\(bu\h'+02'\fBCargo.lock\fR is automatically included if the package contains an -executable binary or example target. \fBcargo\-install\fR(1) will use the -packaged lock file if the \fB\-\-locked\fR flag is used. +\h'-04'\(bu\h'+02'\fBCargo.lock\fR is always included. When missing, a new lock file will be +generated. \fBcargo\-install\fR(1) will use the packaged lock file if +the \fB\-\-locked\fR flag is used. .RE .sp .RS 4