aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java
diff options
context:
space:
mode:
authorGravatar kush <kush@google.com>2018-06-29 15:43:11 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-06-29 15:44:24 -0700
commit8ae7a3ba8c68278b362f6c0e5aa127c96f8f6025 (patch)
treec71926363a04e8dfb51998e990119f3442dd2e88 /src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java
parent55751852c1b54e83514c9ee9d961958a199e1fe5 (diff)
Refactor TemplateExpansionAction so that various strategies can be used to implement it.
Also clarify the behavior of the expand_template API in the presence of multiple-substitutions. RELNOTES: None PiperOrigin-RevId: 202719656
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java
index 1d03df9edf..15d940ea74 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/SkylarkActionFactoryApi.java
@@ -450,8 +450,9 @@ public interface SkylarkActionFactoryApi extends SkylarkValue {
doc =
"Creates a template expansion action. When the action is executed, it will "
+ "generate a file based on a template. Parts of the template will be replaced "
- + "using the <code>substitutions</code> dictionary. Whenever a key of the "
- + "dictionary appears in the template, it is replaced with the associated value. "
+ + "using the <code>substitutions</code> dictionary, in the order the substitutions "
+ + "are specified. Whenever a key of the dictionary appears in the template (or a "
+ + "result of a previous substitution), it is replaced with the associated value. "
+ "There is no special syntax for the keys. You may, for example, use curly braces "
+ "to avoid conflicts (for example, <code>{KEY}</code>). "
+ "<a href=\"https://github.com/bazelbuild/examples/blob/master/rules/"