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

Shorten lines in sharding docs

Browse Source
This commit is contained in:
Martin Hořeňovský 2022-06-22 00:11:02 +02:00
parent 8730260457
commit 6f9f1465c3
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/command-line.md
View File

@ -147,7 +147,7 @@ validity, and throw an error if they are wrong._
> Support for passing arguments to reporters through the `-r`, `--reporter` flag was introduced in Catch2 3.0.1 > Support for passing arguments to reporters through the `-r`, `--reporter` flag was introduced in Catch2 3.0.1
There are multiple built-in reporters, you can see what they do by using the There are multiple built-in reporters, you can see what they do by using the
[`--list-reporter`](command-line.md#listing-available-tests-tags-or-reporters) [`--list-reporter`](command-line.md#listing-available-tests-tags-or-reporters)
flag. If you need a reporter providing custom format outside of the already flag. If you need a reporter providing custom format outside of the already
provided ones, look at the ["write your own reporter" part of the reporter provided ones, look at the ["write your own reporter" part of the reporter
@ -542,12 +542,17 @@ when writing to a file
> [Introduced](https://github.com/catchorg/Catch2/pull/2257) in Catch2 3.0.1. > [Introduced](https://github.com/catchorg/Catch2/pull/2257) in Catch2 3.0.1.
When `--shard-count <#number of shards>` is used, the tests to execute will be split evenly in to the given number of sets, When `--shard-count <#number of shards>` is used, the tests to execute
identified by indicies starting at 0. The tests in the set given by `--shard-index <#shard index to run>` will be executed. will be split evenly in to the given number of sets, identified by indices
The default shard count is `1`, and the default index to run is `0`. It is an error to specify a shard index greater than starting at 0. The tests in the set given by
the number of shards. `--shard-index <#shard index to run>` will be executed. The default shard
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._
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).
This is useful when you want to split test execution across multiple processes, as is done with [Bazel test sharding](https://docs.bazel.build/versions/main/test-encyclopedia.html#test-sharding).
<a id="no-tests-override"></a> <a id="no-tests-override"></a>
## Allow running the binary without tests ## Allow running the binary without tests