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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Document pkg_tar.extension's compression options. #973

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a71a69d
Document pkg_tar.extension.
dougthor42 Aug 8, 2025
c2846c4
Update doc in the correct place
dougthor42 Oct 4, 2025
06760bd
Revert "Document pkg_tar.extension."
dougthor42 Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions pkg/private/tar/tar.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,12 +258,18 @@ pkg_tar_impl = rule(
"ownername": attr.string(default = "."),
"owners": attr.string_dict(),
"ownernames": attr.string_dict(),
"extension": attr.string(default = "tar"),
"extension": attr.string(
default = "tar",
doc = """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.
""",
),
"symlinks": attr.string_dict(),
"empty_files": attr.string_list(),
"include_runfiles": attr.bool(
doc = ("""Include runfiles for executables. These appear as they would in bazel-bin.""" +
"""For example: 'path/to/myprog.runfiles/path/to/my_data.txt'."""),
""" For example: 'path/to/myprog.runfiles/path/to/my_data.txt'."""),
),
"empty_dirs": attr.string_list(),
"remap_paths": attr.string_dict(),
Expand Down