aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google
diff options
context:
space:
mode:
authorGravatar Laurent Le Brun <laurentlb@google.com>2015-08-13 12:56:28 +0000
committerGravatar Florian Weikert <fwe@google.com>2015-08-13 14:02:01 +0000
commit2ab3247957da0a02819ac414ca94861c0d15d5a6 (patch)
tree3f78531fb17b8ee1e2c715348fed1519c0fdc207 /src/main/java/com/google
parent84ff771d0326e9d87291cf52d2bf471c23590c78 (diff)
Build-encyclopedia: Update load documentation
-- MOS_MIGRATED_REVID=100568149
Diffstat (limited to 'src/main/java/com/google')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/be-footer.vm14
1 files changed, 11 insertions, 3 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be-footer.vm b/src/main/java/com/google/devtools/build/docgen/templates/be-footer.vm
index 96b52aedb2..cd308b4f3b 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/be-footer.vm
+++ b/src/main/java/com/google/devtools/build/docgen/templates/be-footer.vm
@@ -463,7 +463,7 @@ exports_files(["jquery-2.1.1.js"])
<p><code>load(path, symbols...)</code></p>
<p><code>load()</code> is a statement that imports definitions from a
- Skylark module. For example:
+ Skylark module (<code>.bzl</code> file). For example:
</p>
<pre class="code">
@@ -476,8 +476,16 @@ build_test(name = ...)
Skylark
module <code>tools/build_rules/build_test.bzl</code> and import the symbol
- <code>build_test</code> in the local environment. By using more arguments, you
- can load more symbols at once.</p>
+ <code>build_test</code> in the local environment. This is useful for
+ using macros or for sharing values between multiple BUILD files. By
+ using more arguments, you can load more symbols at once.</p>
+
+<p>Relative paths are allowed only to load a file from the same directory
+ (not a subdirectory), e.g.</p>
+
+<pre class="code">
+load("build_defs", "COMPILER_FLAGS", "LINKER_FLAGS")
+</pre>
<!-- =================================================================