Skip to content

Commit 53e368d

Browse files
committed
Adjusted documentation about the dirty flag.
1 parent 6810056 commit 53e368d

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/doc/man/cargo-package.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ steps:
3131
executable binary or example target. {{man "cargo-install" 1}} will use the
3232
packaged lock file if the `--locked` flag is used.
3333
- A `.cargo_vcs_info.json` file is included that contains information
34-
about the current VCS checkout hash if available (not included with
35-
`--allow-dirty`).
34+
about the current VCS checkout hash if available, and whether or not the
35+
worktree is dirty.
3636
3. Extract the `.crate` file and build it to verify it can build.
3737
- This will rebuild your package from scratch to ensure that it can be
3838
built from a pristine state. The `--no-verify` flag can be used to skip
@@ -52,12 +52,16 @@ Will generate a `.cargo_vcs_info.json` in the following format
5252
```javascript
5353
{
5454
"git": {
55-
"sha1": "aac20b6e7e543e6dd4118b246c77225e3a3a1302"
55+
"sha1": "aac20b6e7e543e6dd4118b246c77225e3a3a1302",
56+
"dirty": true
5657
},
5758
"path_in_vcs": ""
5859
}
5960
```
6061

62+
`dirty` indicates whether or not the Git worktree was dirty when the package
63+
was built.
64+
6165
`path_in_vcs` will be set to a repo-relative path for packages
6266
in subdirectories of the version control repository.
6367

0 commit comments

Comments
 (0)