3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-22 13:26:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixup shard index docs

Browse Source 
Closes #2547
This commit is contained in:
Martin Hořeňovský 2022-10-16 17:00:23 +02:00
parent 95cd95e591
commit d8619f076b
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/command-line.md
View File

@ -548,7 +548,8 @@ starting at 0. The tests in the set given by
`--shard-index <#shard index to run>` will be executed. The default shard `--shard-index <#shard index to run>` will be executed. The default shard
count is `1`, and the default index to run is `0`. count is `1`, and the default index to run is `0`.
_It is an error to specify a shard index greater than the number of shards._ _Shard index must be less than number of shards. As the name suggests,
it is treated as an index of the shard to run._
Sharding is useful when you want to split test execution across multiple Sharding is useful when you want to split test execution across multiple
processes, as is done with the [Bazel test sharding](https://docs.bazel.build/versions/main/test-encyclopedia.html#test-sharding). processes, as is done with the [Bazel test sharding](https://docs.bazel.build/versions/main/test-encyclopedia.html#test-sharding).