itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #13984 - weihanglo:cargo-package, r=epage

Browse Source 
doc(cargo-package): explain no guarantee of vcs provenance
This commit is contained in:
bors 2024-05-30 15:11:52 +00:00
commit 94aa7fb132
4 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/doc/man/cargo-package.md
View File

@ -61,6 +61,13 @@ Will generate a `.cargo_vcs_info.json` in the following format
`path_in_vcs` will be set to a repo-relative path for packages `path_in_vcs` will be set to a repo-relative path for packages
in subdirectories of the version control repository. in subdirectories of the version control repository.
The compatibility of this file is maintained under the same policy
as the JSON output of {{man "cargo-metadata" 1}}.
Note that this file provides a best-effort snapshot of the VCS information.
However, the provenance of the package is not verified.
There is no guarantee that the source code in the tarball matches the VCS information.
## OPTIONS ## OPTIONS
### Package Options ### Package Options

8
src/doc/man/generated_txt/cargo-package.txt
View File

@ -59,6 +59,14 @@ DESCRIPTION
path_in_vcs will be set to a repo-relative path for packages in path_in_vcs will be set to a repo-relative path for packages in
subdirectories of the version control repository. subdirectories of the version control repository.
The compatibility of this file is maintained under the same policy as
the JSON output of cargo-metadata(1).
Note that this file provides a best-effort snapshot of the VCS
information. However, the provenance of the package is not verified.
There is no guarantee that the source code in the tarball matches the
VCS information.
OPTIONS OPTIONS
Package Options Package Options
-l, --list -l, --list

7
src/doc/src/commands/cargo-package.md
View File

@ -56,6 +56,13 @@ Will generate a `.cargo_vcs_info.json` in the following format
`path_in_vcs` will be set to a repo-relative path for packages `path_in_vcs` will be set to a repo-relative path for packages
in subdirectories of the version control repository. in subdirectories of the version control repository.
The compatibility of this file is maintained under the same policy
as the JSON output of [cargo-metadata(1)](cargo-metadata.html).
Note that this file provides a best-effort snapshot of the VCS information.
However, the provenance of the package is not verified.
There is no guarantee that the source code in the tarball matches the VCS information.
## OPTIONS ## OPTIONS
### Package Options ### Package Options

7
src/etc/man/cargo-package.1
View File

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