diff --git a/src/doc/man/cargo-package.md b/src/doc/man/cargo-package.md index 3d2fd1fbb6d..9d691c12b96 100644 --- a/src/doc/man/cargo-package.md +++ b/src/doc/man/cargo-package.md @@ -32,6 +32,10 @@ stored in the `target/package` directory. This performs the following steps: - 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. + - Symlinks are flattened to their target files. + - Files and directories are included or excluded based on rules mentioned in + [the `[include]` and `[exclude]` fields](../reference/manifest.html#the-exclude-and-include-fields). + 3. Extract the `.crate` file and build it to verify it can build. - This will rebuild your package from scratch to ensure that it can be built from a pristine state. The `--no-verify` flag can be used to skip diff --git a/src/doc/man/generated_txt/cargo-package.txt b/src/doc/man/generated_txt/cargo-package.txt index f25e55b52bb..d7265289ce5 100644 --- a/src/doc/man/generated_txt/cargo-package.txt +++ b/src/doc/man/generated_txt/cargo-package.txt @@ -14,11 +14,13 @@ DESCRIPTION following steps: 1. Load and check the current workspace, performing some basic checks. + o Path dependencies are not allowed unless they have a version key. Cargo will ignore the path key for dependencies in published packages. dev-dependencies do not have this restriction. 2. Create the compressed .crate file. + o The original Cargo.toml file is rewritten and normalized. o [patch], [replace], and [workspace] sections are removed from the @@ -32,7 +34,14 @@ DESCRIPTION about the current VCS checkout hash if available, as well as a flag if the worktree is dirty. + o Symlinks are flattened to their target files. + + o Files and directories are included or excluded based on rules + mentioned in the [include] and [exclude] fields + . + 3. Extract the .crate file and build it to verify it can build. + o This will rebuild your package from scratch to ensure that it can be built from a pristine state. The --no-verify flag can be used to skip this step. diff --git a/src/doc/src/commands/cargo-package.md b/src/doc/src/commands/cargo-package.md index 38fc7f80b4e..d50af10f411 100644 --- a/src/doc/src/commands/cargo-package.md +++ b/src/doc/src/commands/cargo-package.md @@ -27,6 +27,10 @@ stored in the `target/package` directory. This performs the following steps: - 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. + - Symlinks are flattened to their target files. + - Files and directories are included or excluded based on rules mentioned in + [the `[include]` and `[exclude]` fields](../reference/manifest.html#the-exclude-and-include-fields). + 3. Extract the `.crate` file and build it to verify it can build. - This will rebuild your package from scratch to ensure that it can be built from a pristine state. The `--no-verify` flag can be used to skip diff --git a/src/etc/man/cargo-package.1 b/src/etc/man/cargo-package.1 index 691ebc7b633..9f124d96a4b 100644 --- a/src/etc/man/cargo-package.1 +++ b/src/etc/man/cargo-package.1 @@ -45,6 +45,15 @@ packaged lock file if the \fB\-\-locked\fR flag is used. about the current VCS checkout hash if available, as well as a flag if the worktree is dirty. .RE +.sp +.RS 4 +\h'-04'\(bu\h'+02'Symlinks are flattened to their target files. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+02'Files and directories are included or excluded based on rules mentioned in +\fIthe \f(BI[include]\fI and \f(BI[exclude]\fI fields\fR \&. +.RE .RE .sp .RS 4