aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google
diff options
context:
space:
mode:
authorGravatar Laszlo Csomor <laszlocsomor@google.com>2015-03-24 17:19:19 +0000
committerGravatar Lukacs Berki <lberki@google.com>2015-03-25 10:28:59 +0000
commit1e327bf3be225c3d86febbe9e221689c43ffef63 (patch)
treeac36f08be44d5318330d681bf33dc7149dcbfa85 /src/main/java/com/google
parent2234d38fab9ad6f6a7874d54eab8779c1dbf4e9d (diff)
Bazel docs: add missing section about $(location) expansion.
Also fix a typo in contributing.md. -- MOS_MIGRATED_REVID=89411635
Diffstat (limited to 'src/main/java/com/google')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/be-body.html25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be-body.html b/src/main/java/com/google/devtools/build/docgen/templates/be-body.html
index dabadb80bb..0e5b01b270 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/be-body.html
+++ b/src/main/java/com/google/devtools/build/docgen/templates/be-body.html
@@ -197,6 +197,31 @@ in your genrule's cmd attribute.
doing so would trash the source tree.</li>
</ul>
+<h2 id="location">"$(location)" substitution</h2>
+
+<p>
+ In attributes that support it, all occurrences of
+ <code>$(location <i>label</i>)</code> are replaced by the path to the
+ file denoted by <i>label</i>. Use <code>location</code> if the <i>label</i>
+ outputs exactly one filename. This allows bazel to perform a check and give
+ an error if no or more than one files are represented by the given label; a
+ label referring to a source file always represents a single file, but a label
+ referring to a rule refers to all output files of that rule. Otherwise use
+ <code>$(location<b>s</b> <i>label</i>)</code>; bazel will then raise an error
+ if no files are generated. In both cases, if the label is malformed then an
+ error is raised.
+</p>
+<p>
+ The <i>label</i> needs not be in canonical form:
+ <code>foo</code>, <code>:foo</code> and <code>//somepkg:foo</code> are
+ all fine. It may also be the name of an output file from the
+ <code>outs</code> attribute.
+</p>
+<p>
+ The expanded paths are relative to the runfiles directory of the
+ <code>*_test</code> or <code>*_binary</code> rule.
+</p>
+
<h2 id="predefined-python-variables">Predefined Python Variables</h2>
<h3 id="packagename">PACKAGE_NAME</h3>