diff options
| author | Martin Hořeňovský | 2022-06-22 00:11:02 +0200 |
|---|---|---|
| committer | Martin Hořeňovský | 2022-06-22 00:12:16 +0200 |
| commit | 6f9f1465c338225691245ca10a69cf8ef45e8621 (patch) | |
| tree | 004dd7ba77e146a513dc5cd050c9a012bfef4ec4 | |
| parent | 8730260457ddbd19f3df70c53931934398fc54d7 (diff) | |
| download | catch3-6f9f1465c338225691245ca10a69cf8ef45e8621.tar.gz | |
Shorten lines in sharding docs
| -rw-r--r-- | docs/command-line.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/command-line.md b/docs/command-line.md index 81e8b959..218e2f59 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -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 -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) 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 @@ -542,12 +542,17 @@ when writing to a file > [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, -identified by indicies starting at 0. The tests in the set given by `--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. +When `--shard-count <#number of shards>` is used, the tests to execute +will be split evenly in to the given number of sets, identified by indices +starting at 0. The tests in the set given by +`--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> ## Allow running the binary without tests |