Skip to content

Commit e8b6d97

Browse files
committed
docs: More information on what is and isn't included by cargo package
1 parent 82c489f commit e8b6d97

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/doc/man/cargo-package.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ stored in the `target/package` directory. This performs the following steps:
3232
- A `.cargo_vcs_info.json` file is included that contains information
3333
about the current VCS checkout hash if available, as well as a flag if the
3434
worktree is dirty.
35+
- Symlinks are flattened to their target files.
36+
- Subdirectories containing `Cargo.toml` are excluded, as they are assumed
37+
to be separate packages.
38+
- A `target` directory in the root of the package is excluded.
39+
- Files and directories matching the `[include]` and `[exclude]` fields in
40+
the manifest are included or excluded. Include patterns can override the
41+
following rules.
42+
- Files that are ignored by VCS are excluded.
43+
- Unix hidden files and directories (starting with `.`) are excluded.
44+
3545
3. Extract the `.crate` file and build it to verify it can build.
3646
- This will rebuild your package from scratch to ensure that it can be
3747
built from a pristine state. The `--no-verify` flag can be used to skip

0 commit comments

Comments
 (0)