Document pkg_tar.extension's compression options. #973
Conversation
docs/latest.md
Outdated
| | <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"` | |
There was a problem hiding this comment.
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 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
Maybe I just shouldn't mention that xz might not be supported?
There was a problem hiding this comment.
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.
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.
This reverts commit a71a69d.
2 participants
Fixes #972