Skip to content

doc(cargo-package): explain no guarantee of vcs provenance #13984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2024
Merged

doc(cargo-package): explain no guarantee of vcs provenance #13984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/doc/man/cargo-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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

### Package Options
Expand Down
8 changes: 8 additions & 0 deletions src/doc/man/generated_txt/cargo-package.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,14 @@ DESCRIPTION
path_in_vcs will be set to a repo-relative path for packages 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).

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
Package Options
-l, --list
Expand Down
7 changes: 7 additions & 0 deletions src/doc/src/commands/cargo-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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

### Package Options
Expand Down
7 changes: 7 additions & 0 deletions src/etc/man/cargo-package.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ Will generate a \fB\&.cargo_vcs_info.json\fR in the following format
.sp
\fBpath_in_vcs\fR will be set to a repo\-relative path for packages
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"
.SS "Package Options"
.sp
Expand Down