Skip to content

Commit daa4964

Browse files
authored
Document pkg_tar.extension's compression options. (#973)
Fixes #972
2 parents 0026581 + 06760bd commit daa4964

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

pkg/private/tar/tar.bzl

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,12 +261,18 @@ pkg_tar_impl = rule(
261261
"ownername": attr.string(default = "."),
262262
"owners": attr.string_dict(),
263263
"ownernames": attr.string_dict(),
264-
"extension": attr.string(default = "tar"),
264+
"extension": attr.string(
265+
default = "tar",
266+
doc = """The extension of the generated file. If `"gz"`, `"bz2"`, or `"xz"`, the
267+
tarball will also be compressed using that tool, and is mutually exclusive with `compressor`.
268+
Note that `xz` may not be supported based on the Python toolchain.
269+
""",
270+
),
265271
"symlinks": attr.string_dict(),
266272
"empty_files": attr.string_list(),
267273
"include_runfiles": attr.bool(
268274
doc = ("""Include runfiles for executables. These appear as they would in bazel-bin.""" +
269-
"""For example: 'path/to/myprog.runfiles/path/to/my_data.txt'."""),
275+
""" For example: 'path/to/myprog.runfiles/path/to/my_data.txt'."""),
270276
),
271277
"empty_dirs": attr.string_list(),
272278
"remap_paths": attr.string_dict(),

0 commit comments

Comments
 (0)