doc: warn about gzip timestamps (#979)

This commit is contained in:
Sahin Yort 2024-11-04 06:20:11 -08:00 committed by GitHub
parent 250c835b5f
commit f7fb4a92ff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 0 deletions

7
docs/tar.md generated
View File

@ -17,6 +17,13 @@ We also provide full control for tar'ring binaries including their runfiles.
The `tar` binary is hermetic and fully statically-linked. The `tar` binary is hermetic and fully statically-linked.
It is fetched as a toolchain from https://github.com/aspect-build/bsdtar-prebuilt. It is fetched as a toolchain from https://github.com/aspect-build/bsdtar-prebuilt.
## Important Note
When using `compress = "gzip"` its important to disable the non-deterministic time header by providing the `--options=gzip:!timestamp` option.
See: https://datatracker.ietf.org/doc/html/rfc1952#page-5
See: https://github.com/bazel-contrib/bazel-lib/issues/783
## Examples ## Examples
See the [`tar` tests](/lib/tests/tar/BUILD.bazel) for examples of usage. See the [`tar` tests](/lib/tests/tar/BUILD.bazel) for examples of usage.

View File

@ -15,6 +15,13 @@ We also provide full control for tar'ring binaries including their runfiles.
The `tar` binary is hermetic and fully statically-linked. The `tar` binary is hermetic and fully statically-linked.
It is fetched as a toolchain from https://github.com/aspect-build/bsdtar-prebuilt. It is fetched as a toolchain from https://github.com/aspect-build/bsdtar-prebuilt.
## Important Note
When using `compress = "gzip"` its important to disable the non-deterministic time header by providing the `--options=gzip:!timestamp` option.
See: https://datatracker.ietf.org/doc/html/rfc1952#page-5
See: https://github.com/bazel-contrib/bazel-lib/issues/783
## Examples ## Examples
See the [`tar` tests](/lib/tests/tar/BUILD.bazel) for examples of usage. See the [`tar` tests](/lib/tests/tar/BUILD.bazel) for examples of usage.