aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main
diff options
context:
space:
mode:
authorGravatar David Chen <dzc@google.com>2016-08-22 09:04:22 +0000
committerGravatar Philipp Wollermann <philwo@google.com>2016-08-22 14:48:41 +0000
commite2497e1f5c7071cc2054c13beb51304a41bf2217 (patch)
tree5b5064f38fe93c096cf15bd3e67c117b0d1d13b2 /src/main
parent4e844f0d0dfe00f36568b890808585139a7005ff (diff)
Use ${link} references in common attribute documentation.
-- MOS_MIGRATED_REVID=130916210
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html4
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html2
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/common/features.html2
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/common/licenses.html2
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/common/testonly.html4
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/common/visibility.html12
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/test/args.html4
7 files changed, 15 insertions, 15 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 edfc61bb69..0bac9f0457 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="make-variables.html#location">$(location)</a> and
-<a href="make-variables.html">"Make variable"</a> substitution, and
+ <a href="${link make-variables#location}">$(location)</a> and
+ <a href="${link make-variables}">"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/common/distribs.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/distribs.html
index 180adfedcc..70b19eb39d 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="functions.html#distribs"><code>distribs()</code></a> directive.
+<a href="${link 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 66cb58ba92..a37642dcec 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="functions.html#package">package</a> level via the <i>features</i> attribute.<br/>
+ the <a href="${link 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 0535d68deb..9f5855629a 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="functions.html#licenses"><code>licenses()</code></a> directive.
+<a href="${link licenses}"><code>licenses()</code></a> directive.
</p>
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 816e3cc203..ed26e6198f 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="general.html#test_suite">test_suite</a> rules)
+and test suites (<a href="${link test_suite}">test_suite</a> rules)
are <code>testonly</code> by default.
</p>
<p>
By virtue of
-<a href="functions.html#package.default_testonly"><code>default_testonly</code></a>,
+<a href="${link 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 60198d123a..173b344565 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="functions.html#package.default_visibility">default_visibility</a> from
-<a href="functions.html#package">package</a> if specified, else private</code></p>
+default <a href="${link package.default_visibility}">default_visibility</a> from
+<a href="${link 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="functions.html#package_group">package group</a> is
+A <a href="${link 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="functions.html#package.default_visibility">default_visibility</a></code>
-attribute of the <code><a href="functions.html#package">package</a></code>
+the <code><a href="${link package.default_visibility}">default_visibility</a></code>
+attribute of the <code><a href="${link package}">package</a></code>
statement in the BUILD file containing the rule is used
-(except <a href="functions.html#exports_files">exports_files</a>).</p>
+(except <a href="${link 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 161e56f761..7dab0d99d1 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="make-variables.html#location">$(location)</a> and
-<a href="make-variables.html">"Make variable"</a> substitution, and
+<a href="${link make-variables#location}">$(location)</a> and
+<a href="${link make-variables}">"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>