aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen
diff options
context:
space:
mode:
authorGravatar Googler <noreply@google.com>2018-04-26 02:45:11 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-04-26 02:46:34 -0700
commit1210ad94fef7abb9fb8caec26395d07e29579a1b (patch)
tree1e830f524ba09c5e1bc234b54d6975f22b56ce71 /src/main/java/com/google/devtools/build/docgen
parent8e7b0eff16a7ae7f911c3592815076ffe1270953 (diff)
Add a helpful note for the args argument of binary rules.
RELNOTES: None. PiperOrigin-RevId: 194369005
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/binary/args.html6
1 files changed, 6 insertions, 0 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 fb19fb21c6..6ccb833735 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
@@ -13,6 +13,12 @@ passed before the ones that are specified on the <code>bazel run</code> or
</p>
<p>
+<em class="harmful">NOTE: The arguments are not passed when you run the target
+outside of bazel (for example, by manually executing the binary in
+<code>bazel-bin/</code>).</em>
+</p>
+
+<p>
Most binary rules permit an <code>args</code> attribute, but where
this attribute is not allowed, this fact is documented under the
specific rule.