Skip to content

Commit 22185e1

Browse files
committed
doc(cargo-package): explain no guarantee of vcs provenance
1 parent 2c8d176 commit 22185e1

File tree

4 files changed

+29
-0
lines changed

4 files changed

+29
-0
lines changed

src/doc/man/cargo-package.md

+7
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,13 @@ Will generate a `.cargo_vcs_info.json` in the following format
6161
`path_in_vcs` will be set to a repo-relative path for packages
6262
in subdirectories of the version control repository.
6363

64+
The compatibility of this file is maintained under the same policy
65+
as the JSON output of {{man "cargo-metadata" 1}}.
66+
67+
Note that this file provides a best-effort snapshot of the VCS information.
68+
However, the provenance of the package is not verified.
69+
There is no guarantee that the source code in the tarball matches the VCS information.
70+
6471
## OPTIONS
6572

6673
### Package Options

src/doc/man/generated_txt/cargo-package.txt

+8
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,14 @@ DESCRIPTION
5959
path_in_vcs will be set to a repo-relative path for packages in
6060
subdirectories of the version control repository.
6161

62+
The compatibility of this file is maintained under the same policy as
63+
the JSON output of cargo-metadata(1).
64+
65+
Note that this file provides a best-effort snapshot of the VCS
66+
information. However, the provenance of the package is not verified.
67+
There is no guarantee that the source code in the tarball matches the
68+
VCS information.
69+
6270
OPTIONS
6371
Package Options
6472
-l, --list

src/doc/src/commands/cargo-package.md

+7
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,13 @@ Will generate a `.cargo_vcs_info.json` in the following format
5656
`path_in_vcs` will be set to a repo-relative path for packages
5757
in subdirectories of the version control repository.
5858

59+
The compatibility of this file is maintained under the same policy
60+
as the JSON output of [cargo-metadata(1)](cargo-metadata.html).
61+
62+
Note that this file provides a best-effort snapshot of the VCS information.
63+
However, the provenance of the package is not verified.
64+
There is no guarantee that the source code in the tarball matches the VCS information.
65+
5966
## OPTIONS
6067

6168
### Package Options

src/etc/man/cargo-package.1

+7
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,13 @@ Will generate a \fB\&.cargo_vcs_info.json\fR in the following format
8383
.sp
8484
\fBpath_in_vcs\fR will be set to a repo\-relative path for packages
8585
in subdirectories of the version control repository.
86+
.sp
87+
The compatibility of this file is maintained under the same policy
88+
as the JSON output of \fBcargo\-metadata\fR(1).
89+
.sp
90+
Note that this file provides a best\-effort snapshot of the VCS information.
91+
However, the provenance of the package is not verified.
92+
There is no guarantee that the source code in the tarball matches the VCS information.
8693
.SH "OPTIONS"
8794
.SS "Package Options"
8895
.sp

0 commit comments

Comments
 (0)