Revert allow_symlink = True by default for non-executables (#605)
Partial revert of #565, fixes #604.
diff --git a/docs/copy_file_doc.md b/docs/copy_file_doc.md
index 7d97343..8ada8bb 100755
--- a/docs/copy_file_doc.md
+++ b/docs/copy_file_doc.md
@@ -34,7 +34,7 @@
| <a id="copy_file-src"></a>src | A Label. The file to make a copy of. (Can also be the label of a rule that generates a file.) | none |
| <a id="copy_file-out"></a>out | Path of the output file, relative to this package. | none |
| <a id="copy_file-is_executable"></a>is_executable | A boolean. Whether to make the output file executable. When True, the rule's output can be executed using `bazel run` and can be in the srcs of binary and test rules that require executable sources. WARNING: If `allow_symlink` is True, `src` must also be executable. | `False` |
-| <a id="copy_file-allow_symlink"></a>allow_symlink | A boolean. Whether to allow symlinking instead of copying. When False, the output is always a hard copy, but actions consuming that output as an input may still see a symlink (e.g. when using sandboxed excution). When True, the output *can* be a symlink, but there is no guarantee that a symlink is created (i.e., at the time of writing, we don't create symlinks on Windows by default). This defaults to True if `is_executable` is False, and False otherwise. | `None` |
+| <a id="copy_file-allow_symlink"></a>allow_symlink | A boolean. Whether to allow symlinking instead of copying. When False, the output is always a hard copy. When True, the output *can* be a symlink, but there is no guarantee that a symlink is created (i.e., at the time of writing, we don't create symlinks on Windows). Set this to True if you need fast copying and your tools can handle symlinks (which most UNIX tools can). | `False` |
| <a id="copy_file-kwargs"></a>kwargs | further keyword arguments, e.g. `visibility` | none |
diff --git a/rules/private/copy_file_private.bzl b/rules/private/copy_file_private.bzl
index 340339b..444aa18 100644
--- a/rules/private/copy_file_private.bzl
+++ b/rules/private/copy_file_private.bzl
@@ -107,7 +107,7 @@
attrs = _ATTRS,
)
-def copy_file(name, src, out, is_executable = False, allow_symlink = None, **kwargs):
+def copy_file(name, src, out, is_executable = False, allow_symlink = False, **kwargs):
"""Copies a file to another location.
`native.genrule()` is sometimes used to copy files (often wishing to rename them). The 'copy_file' rule does this with a simpler interface than genrule.
@@ -124,12 +124,11 @@
in the srcs of binary and test rules that require executable sources.
WARNING: If `allow_symlink` is True, `src` must also be executable.
allow_symlink: A boolean. Whether to allow symlinking instead of copying.
- When False, the output is always a hard copy, but actions consuming
- that output as an input may still see a symlink (e.g. when using
- sandboxed excution). When True, the output *can* be a symlink, but
- there is no guarantee that a symlink is created (i.e., at the time of
- writing, we don't create symlinks on Windows by default). This
- defaults to True if `is_executable` is False, and False otherwise.
+ When False, the output is always a hard copy. When True, the output
+ *can* be a symlink, but there is no guarantee that a symlink is
+ created (i.e., at the time of writing, we don't create symlinks on
+ Windows). Set this to True if you need fast copying and your tools can
+ handle symlinks (which most UNIX tools can).
**kwargs: further keyword arguments, e.g. `visibility`
"""
@@ -142,9 +141,6 @@
src = src,
out = out,
is_executable = is_executable,
- # Default to True if is_executable is False since symlinking avoids
- # running a full action to copy the file. If the output needs to be
- # executable, a copy may be required if the input isn't.
- allow_symlink = allow_symlink if allow_symlink != None else not is_executable,
+ allow_symlink = allow_symlink,
**kwargs
)
