Skip to content

Commit c2846c4

Browse files
committed
Update doc in the correct place
1 parent a71a69d commit c2846c4

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
@@ -258,12 +258,18 @@ pkg_tar_impl = rule(
258258
"ownername": attr.string(default = "."),
259259
"owners": attr.string_dict(),
260260
"ownernames": attr.string_dict(),
261-
"extension": attr.string(default = "tar"),
261+
"extension": attr.string(
262+
default = "tar",
263+
doc = """The extension of the generated file. If `"gz"`, `"bz2"`, or `"xz"`, the
264+
tarball will also be compressed using that tool, and is mutually exclusive with `compressor`.
265+
Note that `xz` may not be supported based on the Python toolchain.
266+
""",
267+
),
262268
"symlinks": attr.string_dict(),
263269
"empty_files": attr.string_list(),
264270
"include_runfiles": attr.bool(
265271
doc = ("""Include runfiles for executables. These appear as they would in bazel-bin.""" +
266-
"""For example: 'path/to/myprog.runfiles/path/to/my_data.txt'."""),
272+
""" For example: 'path/to/myprog.runfiles/path/to/my_data.txt'."""),
267273
),
268274
"empty_dirs": attr.string_list(),
269275
"remap_paths": attr.string_dict(),

0 commit comments

Comments
 (0)