diff options
author | Lukacs Berki <lberki@google.com> | 2016-01-18 10:14:26 +0000 |
---|---|---|
committer | Han-Wen Nienhuys <hanwen@google.com> | 2016-01-18 14:34:31 +0000 |
commit | 35d60f969f90470275fb1be66fdb132221f0d38f (patch) | |
tree | 6dbab686466c8a58d75f791bb37315fa9c10b39c | |
parent | bcb1beaf0adad3f7409e55ae42f3c8498bd8a0eb (diff) |
Update the documentation of the load() statement because now bare paths are deprecated.
--
MOS_MIGRATED_REVID=112392227
-rw-r--r-- | src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm | 30 |
1 files changed, 25 insertions, 5 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm index fc936a0b26..a8d567ff8c 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm @@ -22,14 +22,14 @@ <h2 id="load">load</h2> -<pre>load(path, symbols...)</pre> +<pre>load(label, symbols...)</pre> <p><code>load()</code> is a statement that imports definitions from a Skylark module (<code>.bzl</code> file). For example: </p> <pre class="code"> -load("/tools/build_rules/build_test", "build_test") +load("//tools/build_rules:build_test.bzl", "build_test") build_test(name = ...) </pre> @@ -42,13 +42,33 @@ build_test(name = ...) 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> +<p> + The label must refer to an existing package. For example, for the above + statement to work, <code>tools/build_rules/BUILD</code> must exist (an empty + file is sufficient) The name of the file must have the suffix + <code>.bzl</code>. If the specified label is in the relative label syntax + (<code>:a/b.bzl</code>), it will be resolved relative to the package the file + the <code>load</code> statement is in. +</p> + +<p> + The <code>load</code> statement still supports the legacy syntax that refers + to Skylark modules by their paths and not by their labels. This statement is + equivalent to the first example: +</p> + +<pre class="code"> +load("/tools/build_rules/build_test", "build_test") +</pre> + +<p> + However, this syntax is deprecated and will be removed soon. +</p> + <!-- ================================================================= package() ================================================================= |