diff options
author | David Chen <dzc@google.com> | 2015-12-02 10:52:26 +0000 |
---|---|---|
committer | Kristina Chodorow <kchodorow@google.com> | 2015-12-02 22:25:30 +0000 |
commit | d63cf4b5524aadb2dc572797a06fe3f169980e7e (patch) | |
tree | 5bc228c2d27b94666b48a2f3951cbcf057b5b36c /src/main/java/com/google/devtools | |
parent | 01220b83fbe68932243d8428786ce294530a300d (diff) |
Fix links in Common Definitions, Make Variables, and Predefined Python
Variables pages.
--
MOS_MIGRATED_REVID=109178629
Diffstat (limited to 'src/main/java/com/google/devtools')
13 files changed, 36 insertions, 33 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html index febe51afc0..edfc61bb69 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html @@ -1,7 +1,7 @@ <p> <code>List of strings; optional; subject to -<a href="#location">$(location)</a> and -<a href="#make_variables">"Make variable"</a> substitution, and +<a href="make-variables.html#location">$(location)</a> and +<a href="make-variables.html">"Make variable"</a> substitution, and <a href="#sh-tokenization">Bourne shell tokenization</a></code> </p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/output_licenses.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/output_licenses.html index 41b64c3200..e474e71850 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/output_licenses.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/output_licenses.html @@ -20,7 +20,7 @@ regular dependency. <p> (For more about the distinction between host and target configurations, -see <a href="bazel-user-manual.html#configurations">Build +see <a href="../bazel-user-manual.html#configurations">Build configurations</a> in the Bazel manual.)</p> <p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/data.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/data.html index 9158cb5c07..5be4ef2009 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/data.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/data.html @@ -1,4 +1,4 @@ -<p><code>List of <a href="build-ref.html#labels">labels</a>; optional</code></p> +<p><code>List of <a href="../build-ref.html#labels">labels</a>; optional</code></p> <p> The list of files needed by this rule at runtime. @@ -9,7 +9,7 @@ Targets named in the <code>data</code> attribute will appear in the <code>*.runfiles</code> area of this rule, if it has one. This may include data files needed by a binary or library, or other programs needed by it. See the -<a href="build-ref.html#data">data dependencies</a> section for more +<a href="../build-ref.html#data">data dependencies</a> section for more information about how to depend on and use data files. </p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/deps.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/deps.html index c5a1469b01..d691c897c3 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/deps.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/deps.html @@ -1,5 +1,5 @@ -<p><code>List of <a href="build-ref.html#labels">labels</a>; optional</code></p> +<p><code>List of <a href="../build-ref.html#labels">labels</a>; optional</code></p> <p> A list of dependencies of this rule. @@ -22,7 +22,7 @@ dependencies are also permitted in many cases: for example, a <code>java_library</code> rule may depend on C++ code in a <code>cc_library</code> rule, by declaring the latter in the <code>deps</code> attribute. See the definition -of <a href="build-ref.html#deps">dependencies</a> for more +of <a href="../build-ref.html#deps">dependencies</a> for more information. </p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html index 52ec24453f..180adfedcc 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html @@ -3,5 +3,5 @@ <p> A list of distribution-method strings to be used for this particular build rule. Overrides the <code>BUILD</code>-file scope defaults defined by the -<a href="#distribs"><code>distribs()</code></a> directive. +<a href="functions.html#distribs"><code>distribs()</code></a> directive. </p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html index 3fe50810e0..66cb58ba92 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html @@ -1,7 +1,7 @@ <p><code>List of <i>features</i>. Default is the empty list.</code></p> <p><i>Features</i> on a rule modify the <i>features</i> currently enabled on -the <a href="#package">package</a> level via the <i>features</i> attribute.<br/> +the <a href="functions.html#package">package</a> level via the <i>features</i> attribute.<br/> For example, if the features ['a', 'b'] are enabled on the package level, and a rule <i>features</i> attribute contains ['-a', 'c'], the features enabled for the rule will be 'b' and 'c'. diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html index 854364e62d..0535d68deb 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html @@ -3,5 +3,5 @@ <p> A list of license-type strings to be used for this particular build rule. Overrides the <code>BUILD</code>-file scope defaults defined by the -<a href="#licenses"><code>licenses()</code></a> directive. +<a href="functions.html#licenses"><code>licenses()</code></a> directive. </p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html index ddb5f0e9b1..1937b33525 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html @@ -8,8 +8,10 @@ <i>Tags</i> can be used on any rule. <i>Tags</i> on test and <code>test_suite</code> rules are useful for categorizing the tests. <i>Tags</i> on non-test rules are used to control sandboxed execution of - <code>genrule</code>s and [Skylark](/docs/skylark/index.html) actions, and for - parsing by humans and/or external tools. + <code>genrule</code>s and + +<a href="/docs/skylark/index.html">Skylark</a> + actions, and for parsing by humans and/or external tools. </p> <p> @@ -22,8 +24,8 @@ <ul> <li><code>local</code> keyword results in the action or test never being run remotely or inside the - [sandbox](/docs/bazel-user-manual.html#sandboxing). - For genrules and tests, marking the rule with the <code>local=1</code> + <a href="../bazel-user-manual.html#sandboxing">sandbox</a>. + For genrules and tests, marking the rule with the <code>local = 1</code> attribute has the same effect. </li> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html index 14153dfc3d..816e3cc203 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html @@ -11,13 +11,13 @@ depend on any rule that is <code>testonly</code>. <p> Tests (<code>*_test</code> rules) -and test suites (<a href="#test_suite">test_suite</a> rules) +and test suites (<a href="general.html#test_suite">test_suite</a> rules) are <code>testonly</code> by default. </p> <p> By virtue of -<a href="#package.default_testonly"><code>default_testonly</code></a>, +<a href="functions.html#package.default_testonly"><code>default_testonly</code></a>, targets under <code>javatests</code> are <code>testonly</code> by default. </p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html index 37d6f5b5bd..d31021f49e 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html @@ -1,6 +1,6 @@ -<p><code>List of <a href="build-ref.html#labels">labels</a>; optional; -default <a href="#package">default_visibility</a> from -<a href="#package">package</a> if specified, else private</code></p> +<p><code>List of <a href="../build-ref.html#labels">labels</a>; optional; +default <a href="functions.html#package.default_visibility">default_visibility</a> from +<a href="functions.html#package">package</a> if specified, else private</code></p> <p> The <code>visibility</code> attribute on a rule controls whether @@ -33,7 +33,7 @@ in one of their sub-packages have access to this rule. For example, this rule (but not <code>//independent:evil</code>) </li> <li><code>["//some/package:my_package_group"]</code>: -A <a href="#package_group">package group</a> is +A <a href="functions.html#package_group">package group</a> is a named set of package names. Package groups can also grant access rights to entire subtrees, e.g.<code>//myproj/...</code>. </li> @@ -46,10 +46,10 @@ can not be combined with any other visibility specifications. A visibility specification may contain a combination of package labels (i.e. <code>//foo:__pkg__</code>) and <code>package_group</code>s.</p> <p>If a rule does not specify the visibility attribute, -the <code><a href="#package">default_visibility</a></code> -attribute of the <code><a href="#package">package</a></code> +the <code><a href="functions.html#package.default_visibility">default_visibility</a></code> +attribute of the <code><a href="functions.html#package">package</a></code> statement in the BUILD file containing the rule is used -(except <a href="#exports_files">exports_files</a>).</p> +(except <a href="functions.html#exports_files">exports_files</a>).</p> <p>If the default visibility for the package is not specified, the rule is private.</p> <p><b>Example</b>:</p> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html index ff01cf1df4..161e56f761 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html @@ -1,6 +1,6 @@ <p><code>List of strings; optional; subject to -<a href="#location">$(location)</a> and -<a href="#make_variables">"Make variable"</a> substitution, and +<a href="make-variables.html#location">$(location)</a> and +<a href="make-variables.html">"Make variable"</a> substitution, and <a href="#sh-tokenization">Bourne shell tokenization</a></code></p> <p>Add these arguments to the <code>--test_arg</code> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm index 4b33058e7c..aa3f96c4f9 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm @@ -9,7 +9,7 @@ many functions or build rules below. <div class="toc"> <h1>Contents</h1> <ul> - <li><a href="#borne-shell-tokenization">Borne shell tokenization</a></li> + <li><a href="#sh-tokenization">Borne shell tokenization</a></li> <li><a href="#label-expansion">Label Expansion</a></li> <li><a href="#common-attributes">Attributes common to all build rules</a></li> <li><a href="#common-attributes-tests">Attributes common to all test rules (*_test)</a></li> @@ -109,9 +109,9 @@ labels attribute. depend on the command-line flags passed to Bazel. This can be used, for example, to declare platform-dependent <code>srcs</code> or custom compiler flags depending on the - <a href="bazel-user-manual.html#flag--compilation_mode">compilation + <a href="../bazel-user-manual.html#flag--compilation_mode">compilation mode</a>. This feature is very close in spirit to - <a href="#cc_library.abi_deps">abi_deps</a>, except that it's not + <a href="c-cpp.html#cc_library.abi_deps">abi_deps</a>, except that it's not limited to <code>cc_*</code> rules and the <code>deps</code> attribute. </p> @@ -150,7 +150,7 @@ labels attribute. <p> An important but somewhat subtle distinction between the two namespaces used by the build system: - <a href="build-ref.html#labels">labels</a> identify <em>targets</em>, + <a href="../build-ref.html#labels">labels</a> identify <em>targets</em>, which may be rules or files, and file targets may be divided into either source (or input) file targets and derived (or output) file targets. These are the things you can mention in BUILD files, @@ -163,7 +163,7 @@ labels attribute. cannot be referenced from within BUILD files or from the command line. In this way, the build tool may hide certain implementation details of how it does its job. This is explained more fully in - the <a href="build-ref.html">BUILD Concept Reference</a>. + the <a href="../build-ref.html">BUILD Concept Reference</a>. </p> #parse("com/google/devtools/build/docgen/templates/be/footer.vm") diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm index 773dcdf2ef..02c8055d05 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm @@ -9,7 +9,7 @@ <div class="toc"> <ul> <li><a href="#make-var-substitution">"Make" variable subsitution</a></li> - <li><a href="#predefined-variables">Predefined variables</a></li> + <li><a href="#predefined_variables">Predefined variables</a></li> <li><a href="#location">"$(location)" substitution</a></li> </ul> </div> @@ -29,7 +29,7 @@ </p> <p>Build rules can introduce additional rule specific variables. One example is - the <a href="#genrule.cmd"><code>cmd</code> attribute of a genrule</a>. + the <a href="general.html#genrule.cmd"><code>cmd</code> attribute of a genrule</a>. </p> <h2 id='make-var-substitution'>"Make" variable substitution</h2> @@ -141,7 +141,8 @@ in your genrule's cmd attribute. <p id="predefined_variables.genrule.cmd"> <strong> - Other Variables available to <a href="#genrule.cmd">the cmd attribute of a genrule</a> + Other Variables available to <a href="general.html#genrule.cmd">the cmd + attribute of a genrule</a> </strong> </p> <ul><!-- keep alphabetically sorted --> |