aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Rodrigo Queiro <rodrigoq@google.com>2017-08-25 14:10:21 +0200
committerGravatar Damien Martin-Guillerez <dmarting@google.com>2017-08-25 16:04:13 +0200
commit054403d7dacc0b89b7c45e67adab261e4ce854a2 (patch)
treeae7affdfef6919817768ed134461aa6d8542ee18
parentf6291af5e330de7fed16257748dab739eb72beb7 (diff)
Add a warning to the bind() docs
This will encourage new users to avoid it, and would have helped me. At the start, I cargo-culted other projects that use bind() heavily without knowing why. Related: #1952 Closes #3608. PiperOrigin-RevId: 166464352
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java b/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java
index da7ffb36d3..e6c20a4093 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/repository/BindRule.java
@@ -61,6 +61,10 @@ public final class BindRule implements RuleDefinition {
}
/*<!-- #BLAZE_RULE (NAME = bind, TYPE = OTHER, FAMILY = Workspace)[GENERIC_RULE] -->
+<em><p>Warning: use of <code>bind()</code> is not recommended. See "<a
+href="https://github.com/bazelbuild/bazel/issues/1952">Consider removing bind</a>" for a long
+discussion of its issues and alternatives.</p></em>
+
<p>Gives a target an alias in the <code>//external</code> package.</p>
<p>The <code>//external</code> package is not a "normal" package: there is no external/ directory,