aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools
diff options
context:
space:
mode:
authorGravatar Dave MacLachlan <dmaclach@google.com>2016-04-11 22:30:03 +0000
committerGravatar Dmitry Lomov <dslomov@google.com>2016-04-12 13:58:59 +0000
commit5901f8e69748cc533fc8d7e644bcef43ba56b756 (patch)
tree6bf3f47fdb35f89edd79d443e315dbac060f3b43 /src/main/java/com/google/devtools
parent84fa762031bf7057f1cba9c93a3f44c2d4ddc3af (diff)
Document the difference between actions and genrules since the question has come up a couple of times.
RELNOTES: -- MOS_MIGRATED_REVID=119578035
Diffstat (limited to 'src/main/java/com/google/devtools')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleImplementationFunctions.java5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleImplementationFunctions.java b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleImplementationFunctions.java
index 40f5f903c0..a0e00ff62d 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleImplementationFunctions.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleImplementationFunctions.java
@@ -94,7 +94,10 @@ public class SkylarkRuleImplementationFunctions {
name = "action",
doc =
"Creates an action that runs an executable or a shell command. You must specify either "
- + "<code>command</code> or <code>executable</code>.",
+ + "<code>command</code> or <code>executable</code>.\n"
+ + "Actions and genrules are very similar, but have different use cases. Actions are "
+ + "used inside rules, and genrules are used inside macros. Genrules also have make "
+ + "variable expansion.",
objectType = SkylarkRuleContext.class,
returnType = Runtime.NoneType.class,
mandatoryPositionals = {