- Notifications
You must be signed in to change notification settings - Fork202
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Document pkg_tar.extension's compression options.#973
Conversation
docs/latest.md Outdated
| | <aid="pkg_tar-empty_dirs"></a>empty_dirs| -| List of strings| optional|`[]`| | ||
| | <aid="pkg_tar-empty_files"></a>empty_files| -| List of strings| optional|`[]`| | ||
| | <aid="pkg_tar-extension"></a>extension| -| String| optional|`"tar"`| | ||
| | <aid="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"`| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Note that
xzmay not be supported based on the Python toolchain.
I'm not 100% sure this is true. The source has a TODO to confirmxz availabilty, but it's been there for > 3 years now andHAS_XZ_SUPPORT is True.
rules_pkg/pkg/private/tar/tar.bzl
Lines 29 to 31 in8c7c2cf
| # 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 thatxz might not be supported?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This is fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
But the problem is that it won't work if you change it here.
It will get lost on the next release update when the file is generated. You need to change it in the rule souce.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Ah, thanks for letting me know. I've updated the starlark source instead, please LMK if there's something else I'm supposed to do.
Fixes#972