aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/docgen/templates/attributes
diff options
context:
space:
mode:
authorGravatar Ulf Adams <ulfjack@google.com>2015-08-28 12:26:59 +0000
committerGravatar John Field <jfield@google.com>2015-08-28 15:00:23 +0000
commit750909cb3c2bd7b47ae02cb78cf4f19c954fc121 (patch)
tree32aab5c938f33323b54fa822a5e35cdf13090923 /src/main/java/com/google/devtools/build/docgen/templates/attributes
parentbd42b382a1d14a343ae7235f090266bab1fdcb77 (diff)
Push local and shard_count documentation.
-- MOS_MIGRATED_REVID=101768878
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen/templates/attributes')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/test/local.html7
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/test/shard_count.html14
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html2
3 files changed, 22 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/local.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/local.html
new file mode 100644
index 0000000000..5bcad595f1
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/local.html
@@ -0,0 +1,7 @@
+<p><code>Boolean; optional</code></p>
+
+<p>Forces the test to be run locally, without sandboxing.</p>
+
+<p>By default this attribute is set to 0 and the default testing strategy is
+used. This is equivalent to providing "local" as a tag
+(<code>tags=["local"]</code>).</p>
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/shard_count.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/shard_count.html
new file mode 100644
index 0000000000..f2e76e85f4
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/shard_count.html
@@ -0,0 +1,14 @@
+<p>Non-negative integer less than or equal to 50;
+optional</p>
+
+<p>Specifies the number of parallel shards
+to use to run the test.</p>
+
+<p>This value will override any heuristics used to determine the number of
+parallel shards with which to run the test. Note that for some test
+rules, this parameter may be required to enable sharding
+in the first place. Also see <code>--test_sharding_strategy</code>.</p>
+
+<p>Sharding requires the test runner to support the test sharding protocol.
+If it does not, then it will most likely run every test in every shard, which
+is not what you want.</p>
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html
index 1dea0ae889..9da6c57d80 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html
+++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/test/size.html
@@ -1,5 +1,5 @@
<p><code>String "enormous", "large" "medium" or "small",
-default is "medium"</code></p>
+default is "medium"; optional</code></p>
<p>How "heavy" the test is.</p>