aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools
diff options
context:
space:
mode:
authorGravatar elenairina <elenairina@google.com>2017-08-03 14:46:37 +0200
committerGravatar Dmitry Lomov <dslomov@google.com>2017-08-03 15:43:23 +0200
commit3774341ff0544497e6e71f405cb222e87f98eb4c (patch)
treeb418ceb800e0deabc52f7b19bfc4fe657324cb56 /src/main/java/com/google/devtools
parentb3be32e7135895737b64e3ad8ddb09176bfc8dd5 (diff)
Update doc of ctx.coverage_instrumented.
Fixes #3434 PiperOrigin-RevId: 164113116
Diffstat (limited to 'src/main/java/com/google/devtools')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
index 51dbdf02bf..10e246e8d6 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java
@@ -743,8 +743,11 @@ public final class SkylarkRuleContext implements SkylarkValue {
@SkylarkCallable(name = "coverage_instrumented",
doc = "Returns whether code coverage instrumentation should be generated when performing "
+ "compilation actions for this rule or, if <code>target</code> is provided, the rule "
- + "specified by that Target. (If a non-rule Target is provided, this returns False.) This "
- + "differs from <code>coverage_enabled</code> in the <a href=\"configuration.html\">"
+ + "specified by that Target. (If a non-rule or a Skylark rule Target is provided, this "
+ + "returns False.) Checks if the sources of the current rule (if no Target is provided) or"
+ + "the sources of Target should be instrumented based on the --instrumentation_filter and"
+ + "--instrument_test_targets config settings. "
+ + "This differs from <code>coverage_enabled</code> in the <a href=\"configuration.html\">"
+ "configuration</a>, which notes whether coverage data collection is enabled for the "
+ "entire run, but not whether a specific target should be instrumented.",
parameters = {