diff --git a/src/doc/man/cargo-package.md b/src/doc/man/cargo-package.md index 5057e59fe79..05d0925971f 100644 --- a/src/doc/man/cargo-package.md +++ b/src/doc/man/cargo-package.md @@ -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 diff --git a/src/doc/man/generated_txt/cargo-package.txt b/src/doc/man/generated_txt/cargo-package.txt index f24d09b75c9..1cbee480709 100644 --- a/src/doc/man/generated_txt/cargo-package.txt +++ b/src/doc/man/generated_txt/cargo-package.txt @@ -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 diff --git a/src/doc/src/commands/cargo-package.md b/src/doc/src/commands/cargo-package.md index 94fd89bd670..87f56f98809 100644 --- a/src/doc/src/commands/cargo-package.md +++ b/src/doc/src/commands/cargo-package.md @@ -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 diff --git a/src/etc/man/cargo-package.1 b/src/etc/man/cargo-package.1 index a6ab96cb634..f515beaad5a 100644 --- a/src/etc/man/cargo-package.1 +++ b/src/etc/man/cargo-package.1 @@ -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