diff options
author | 2015-03-23 10:46:07 +0000 | |
---|---|---|
committer | 2015-03-23 11:58:09 +0000 | |
commit | 2cb94fe51aefd225bceeaf150ca82ef807abd256 (patch) | |
tree | 97825d09137346b251f687eb1cc4bc09563c8903 /src/main/java/com/google/devtools/build/lib | |
parent | 42fc1c258d1b2c0320f15779204ae682db6b0352 (diff) |
Skylark: document ctx.expand_make_variables.
--
MOS_MIGRATED_REVID=89285345
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib')
-rw-r--r-- | src/main/java/com/google/devtools/build/lib/rules/SkylarkRuleContext.java | 18 |
1 files changed, 17 insertions, 1 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 b9c44558ba..826d9f5cfa 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 @@ -465,7 +465,23 @@ public final class SkylarkRuleContext { return true; } - @SkylarkCallable(doc = "") + @SkylarkCallable(doc = + "Returns a string after expanding all references to \"Make variables\". The variables " + + "have to have the following format: <code>$(VAR_NAME)</code>. Also, <code>$$VAR_NAME" + + "</code> expands to <code>$VAR_NAME</code>. Parameters:" + + "<ul><li>The name of the attribute (<code>string</code>). It's only used for error " + + "reporting.</li>\n" + + "<li>The expression to expand (<code>string</code>). It can contain references to " + + "\"Make variables\".</li>\n" + + "<li>A mapping of additional substitutions (<code>dict</code> of <code>string</code> : " + + "<code>string</code>).</li></ul>\n" + + "Examples:" + + "<pre class=language-python>\n" + + "ctx.expand_make_variables(\"cmd\", \"$(MY_VAR)\", {\"MY_VAR\": \"Hi\"}) # == \"Hi\"\n" + + "ctx.expand_make_variables(\"cmd\", \"$$PWD\", {}) # == \"$PWD\"\n" + + "</pre>" + + "Additional variables may come from other places, such as configurations. Note that " + + "this function is experimental.") public String expandMakeVariables(String attributeName, String command, final Map<String, String> additionalSubstitutions) { return ruleContext.expandMakeVariables(attributeName, |