diff options
| author |  Vladimir Moskva <vladmos@google.com> | 2017-03-20 15:15:46 +0000 |
|---|---|---|
| committer |  Yue Gan <yueg@google.com> | 2017-03-21 12:48:08 +0000 |
| commit | 4362067845121a9f6de83b2901f8a016891f7fdc (patch) | |
| tree | 124f17e930d659190095b53df4a46a2462425d37 /src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java | |
| parent | edd531d9fb9ff6b47ac2ea7a530fea8e5deef2bd (diff) | |
Document default_provider.
The documentation is not final as default_provider is not completely
implemented now, but it reflects its current state.
--
PiperOrigin-RevId: 150627015
MOS_MIGRATED_REVID=150627015
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java')
| -rw-r--r-- | src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java | 10 |
1 files changed, 8 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 9f3aa43e5f..3e763a2008 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 @@ -527,7 +527,13 @@ public final class SkylarkRuleContext { } }; - @SkylarkCallable(name = "default_provider", structField = true) + @SkylarkCallable(name = "default_provider", structField = true, + doc = "A provider that's provided by every rule, even if it's not returned explicitly. " + + "A <code>default_provider</code> accepts all special parameters that can be returned " + + "from rule implementation function in a struct, which are <code>runfiles</code>, " + + "<code>data_runfiles</code>, <code>default_runfiles</code>, " + + "<code>output_groups</code>, <code>instrumented_files</code>, and all " + + "<a href=\"skylark-provider.html\">providers</a> that are available on built-in rules.") public static ClassObjectConstructor getDefaultProvider() { return DEFAULT_PROVIDER; } @@ -541,7 +547,7 @@ public final class SkylarkRuleContext { + "will have to call this function again if you wish to inspect them. " + "<br/><br/>" + "This is intended to help write tests for rule-implementation helper functions, which " - + "may take in a<code>ctx</code> object and create actions on it.") + + "may take in a <code>ctx</code> object and create actions on it.") public Object createdActions() { if (ruleContext.getRule().getRuleClassObject().isSkylarkTestable()) { return ActionsProvider.create( |