Skip to content

Document pkg_tar.extension's compression options. #973

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document pkg_tar.extension's compression options. #973

wants to merge 1 commit into from

Conversation

dougthor42
Copy link

Fixes #972

dougthor42
dougthor42 commented Aug 8, 2025
View reviewed changes
docs/latest.md
| <a id="pkg_tar-empty_dirs"></a>empty_dirs | - | List of strings | optional | `[]` |
| <a id="pkg_tar-empty_files"></a>empty_files | - | List of strings | optional | `[]` |
| <a id="pkg_tar-extension"></a>extension | - | String | optional | `"tar"` |
| <a id="pkg_tar-extension"></a>extension | The extension of the generated file. If `"gz"`, `"bz2"`, or `"xz"`, the tarball will also be compressed using that tool, and is mutually exclusive with `compressor`. Note that `xz` may not be supported based on the Python toolchain. | String | optional | `"tar"` |
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that xz may not be supported based on the Python toolchain.

I'm not 100% sure this is true. The source has a TODO to confirm xz availabilty, but it's been there for > 3 years now and HAS_XZ_SUPPORT is True.

rules_pkg/pkg/private/tar/tar.bzl

Lines 29 to 31 in 8c7c2cf

# TODO(aiuto): Figure out how to get this from the python toolchain.
# See check for lzma in archive.py for a hint at a method.
HAS_XZ_SUPPORT = True

Maybe I just shouldn't mention that xz might not be supported?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aiuto aiuto Awaiting requested review from aiuto aiuto is a code owner

@jylinv0 jylinv0 Awaiting requested review from jylinv0

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document compression support for pkg_tar
1 participant
@dougthor42