aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen
diff options
context:
space:
mode:
authorGravatar lberki <lberki@google.com>2018-06-05 11:50:12 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-06-05 11:51:33 -0700
commitb84e1a6fd960af6553a0581990cca182c6d51a05 (patch)
treea14d403c24bb7ed7d5edbb081e928984d71c188d /src/main/java/com/google/devtools/build/docgen
parentf2a358e08c80c3848b08e45eb9f9b108db6ffb1e (diff)
Add documentation for the toolchains= attribute.
RELNOTES: None. PiperOrigin-RevId: 199333903
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/PredefinedAttributes.java1
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/common/toolchains.html15
2 files changed, 16 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/PredefinedAttributes.java b/src/main/java/com/google/devtools/build/docgen/PredefinedAttributes.java
index fddbf78b67..03e711ebde 100644
--- a/src/main/java/com/google/devtools/build/docgen/PredefinedAttributes.java
+++ b/src/main/java/com/google/devtools/build/docgen/PredefinedAttributes.java
@@ -53,6 +53,7 @@ public class PredefinedAttributes {
"templates/attributes/common/restricted_to.html",
"templates/attributes/common/tags.html",
"templates/attributes/common/testonly.html",
+ "templates/attributes/common/toolchains.html",
"templates/attributes/common/visibility.html");
/**
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/toolchains.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/toolchains.html
new file mode 100644
index 0000000000..bf5d95d4a5
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/toolchains.html
@@ -0,0 +1,15 @@
+<p><code>List of <a href="../build-ref.html#labels">labels</a>; optional</code></p>
+
+<p>
+The set of <a href="../toolchains.html">toolchains</a> this rule has access to.
+</p>
+
+</p>Targets listed here are the set of toolchains whose <a href="${link make-variables}">Make
+variables</a> the rule is allowed to access.</a> These rules are either rules that provide
+the <code>TemplateVariableInfo</code> provider or special targets for toolchain types built into
+Bazel. These include:
+
+<ul>
+ <li><code>@bazel_tools//tools/cpp:current_cc_toolchain</code>
+ <li><code>@bazel_tools//tools/cpp:current_java_runtime</code>
+ </ul>