aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java
diff options
context:
space:
mode:
authorGravatar laurentlb <laurentlb@google.com>2017-07-21 16:24:52 +0200
committerGravatar Jakob Buchgraber <buchgr@google.com>2017-07-24 09:51:08 +0200
commitab5ca78269caac5553b97464161e763fed988585 (patch)
tree38b594453ef46593430687b82766a1f0cc050809 /src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java
parentddb1823246b2ef60cfdff2047abae35cdfb94392 (diff)
Add links to examples in the documentation.
RELNOTES: None. PiperOrigin-RevId: 162738376
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java b/src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java
index ea7fd9ee71..4360561628 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/SkylarkActionFactory.java
@@ -206,7 +206,9 @@ public class SkylarkActionFactory implements SkylarkValue {
"Creates a file write action. When the action is executed, it will write the given content "
+ "to a file. This is used to generate files using information available in the "
+ "analysis phase. If the file is large and with a lot of static content, consider "
- + "using <a href=\"#expand_template\">expand_template</a>.",
+ + "using <a href=\"#expand_template\">expand_template</a>. "
+ + "<a href=\"https://github.com/laurentlb/examples/blob/master/rules/executable/executable.bzl\">"
+ + "See example of use</a>",
parameters = {
@Param(name = "output", type = Artifact.class, doc = "the output file.", named = true),
@Param(
@@ -641,7 +643,9 @@ public class SkylarkActionFactory implements SkylarkValue {
+ "using the <code>substitutions</code> dictionary. Whenever a key of the "
+ "dictionary appears in the template, 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 (e.g. <code>{KEY}</code>).",
+ + "to avoid conflicts (e.g. <code>{KEY}</code>). "
+ + "<a href=\"https://github.com/laurentlb/examples/blob/master/rules/expand_template/hello.bzl\">"
+ + "See example of use</a>",
parameters = {
@Param(
name = "template",