diff options
| author | Martin Hořeňovský | 2022-05-17 22:13:36 +0200 |
|---|---|---|
| committer | Martin Hořeňovský | 2022-05-17 22:13:36 +0200 |
| commit | 605a34765aa5d5ecbf476b4598a862ada971b0cc (patch) | |
| tree | 12f9c74f3d86a2996b1bc2355b635926a0b24ebf /docs | |
| parent | abb669d4fdaeb08ec7e087541d32e7130bc775ef (diff) | |
| download | catch3-3.0.1.tar.gz | |
v3.0.1v3.0.1
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/command-line.md | 22 | ||||
| -rw-r--r-- | docs/configuration.md | 2 | ||||
| -rw-r--r-- | docs/matchers.md | 4 | ||||
| -rw-r--r-- | docs/other-macros.md | 4 | ||||
| -rw-r--r-- | docs/release-notes.md | 6 | ||||
| -rw-r--r-- | docs/reporter-events.md | 4 | ||||
| -rw-r--r-- | docs/reporters.md | 4 |
7 files changed, 24 insertions, 22 deletions
diff --git a/docs/command-line.md b/docs/command-line.md index 4b9ec7a0..86b06aa0 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -145,7 +145,7 @@ hardcoded into Catch2. Currently there are only 2, _Note that the reporter might still check the X-prefixed options for validity, and throw an error if they are wrong._ -> Support for passing arguments to reporters through the `-r`, `--reporter` flag was introduced in Catch2 X.Y.Z +> 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 [`--list-reporter`](command-line.md#listing-available-tests-tags-or-reporters) @@ -160,7 +160,7 @@ reporter can be provided without the output-file part of reporter spec. This reporter will use the "default" output destination, based on the [`-o`, `--out`](#sending-output-to-a-file) option. -> Support for using multiple different reporters at the same time was [introduced](https://github.com/catchorg/Catch2/pull/2183) in Catch2 X.Y.Z +> Support for using multiple different reporters at the same time was [introduced](https://github.com/catchorg/Catch2/pull/2183) in Catch2 3.0.1 _Note: There is currently no way to escape `::` in the reporter spec, @@ -204,9 +204,9 @@ Sometimes this results in a flood of failure messages and you'd rather just see --list-listeners ``` -> The `--list*` options became customizable through reporters in Catch2 X.Y.Z +> The `--list*` options became customizable through reporters in Catch2 3.0.1 -> The `--list-listeners` option was added in Catch2 X.Y.Z +> The `--list-listeners` option was added in Catch2 3.0.1 `--list-tests` lists all registered tests matching specified test spec. Usually this listing also includes tags, and potentially also other @@ -230,7 +230,7 @@ Use this option to send all output to a file, instead of stdout. You can use `-` as the filename to explicitly send the output to stdout (this is useful e.g. when using multiple reporters). -> Support for `-` as the filename was introduced in Catch2 X.Y.Z +> Support for `-` as the filename was introduced in Catch2 3.0.1 Filenames starting with "%" (percent symbol) are reserved by Catch2 for meta purposes, e.g. using `%debug` as the filename opens stream that @@ -242,7 +242,7 @@ Catch2 currently recognizes 3 meta streams: * `%stdout` - writes to stdout * `%stderr` - writes to stderr -> Support for `%stdout` and `%stderr` was introduced in Catch2 X.Y.Z +> Support for `%stdout` and `%stderr` was introduced in Catch2 3.0.1 <a id="naming-a-test-run"></a> @@ -290,7 +290,7 @@ There are currently two warnings implemented: // not match any tests. ``` -> `UnmatchedTestSpec` was introduced in Catch2 X.Y.Z. +> `UnmatchedTestSpec` was introduced in Catch2 3.0.1. <a id="reporting-timings"></a> @@ -388,7 +388,7 @@ either before running any tests, after running all tests - or both, depending on ## Skip all benchmarks <pre>--skip-benchmarks</pre> -> [Introduced](https://github.com/catchorg/Catch2/issues/2408) in Catch X.Y.Z. +> [Introduced](https://github.com/catchorg/Catch2/issues/2408) in Catch2 3.0.1. This flag tells Catch2 to skip running all benchmarks. Benchmarks in this case mean code blocks in `BENCHMARK` and `BENCHMARK_ADVANCED` macros, not @@ -507,7 +507,7 @@ So, for example, tests within the file `~\Dev\MyProject\Ferrets.cpp` would be t ## Override output colouring <pre>--colour-mode <ansi|win32|none|default></pre> -> The `--colour-mode` option replaced the old `--colour` option in Catch2 X.Y.Z +> The `--colour-mode` option replaced the old `--colour` option in Catch2 3.0.1 Catch2 support two different ways of colouring terminal output, and by @@ -531,7 +531,7 @@ when writing to a file ## Test Sharding <pre>--shard-count <#number of shards>, --shard-index <#shard index to run></pre> -> [Introduced](https://github.com/catchorg/Catch2/pull/2257) in Catch2 X.Y.Z. +> [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. @@ -544,7 +544,7 @@ This is useful when you want to split test execution across multiple processes, ## Allow running the binary without tests <pre>--allow-running-no-tests</pre> -> Introduced in Catch2 X.Y.Z. +> Introduced in Catch2 3.0.1. By default, Catch2 test binaries return non-0 exit code if no tests were run, e.g. if the binary was compiled with no tests, or the provided test diff --git a/docs/configuration.md b/docs/configuration.md index dc7178c7..d5463343 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -101,7 +101,7 @@ is equivalent with the out-of-the-box experience. When `CATCH_CONFIG_BAZEL_SUPPORT` is defined, Catch2 will register a `JUnit` reporter writing to a path pointed by `XML_OUTPUT_FILE` provided by Bazel. -> `CATCH_CONFIG_BAZEL_SUPPORT` was [introduced](https://github.com/catchorg/Catch2/pull/2399) in Catch2 X.Y.Z. +> `CATCH_CONFIG_BAZEL_SUPPORT` was [introduced](https://github.com/catchorg/Catch2/pull/2399) in Catch2 3.0.1. ## C++11 toggles diff --git a/docs/matchers.md b/docs/matchers.md index e76d8490..3d0f8f11 100644 --- a/docs/matchers.md +++ b/docs/matchers.md @@ -248,7 +248,7 @@ Note that `DerivedException` in the example above has to derive from ### Generic range Matchers -> Generic range matchers were introduced in Catch2 X.Y.Z +> Generic range matchers were introduced in Catch2 3.0.1 Catch2 also provides some matchers that use the new style matchers definitions to handle generic range-like types. These are: @@ -350,7 +350,7 @@ style matchers arbitrarily. ## Writing custom matchers (new style) -> New style matchers were introduced in Catch2 X.Y.Z +> New style matchers were introduced in Catch2 3.0.1 To create a new-style matcher, you have to create your own type that derives from `Catch::Matchers::MatcherGenericBase`. Your type has to diff --git a/docs/other-macros.md b/docs/other-macros.md index ce33c1d8..24a0fb6e 100644 --- a/docs/other-macros.md +++ b/docs/other-macros.md @@ -15,7 +15,7 @@ stringification machinery to the _expr_ and records the result. As with evaluates to `true`. `CHECKED_ELSE( expr )` work similarly, but the block is entered only if the _expr_ evaluated to `false`. -> `CHECKED_X` macros were changed to not count as failure in Catch2 X.Y.Z. +> `CHECKED_X` macros were changed to not count as failure in Catch2 3.0.1. Example: ```cpp @@ -77,7 +77,7 @@ TEST_CASE("STATIC_REQUIRE showcase", "[traits]") { } ``` -> `STATIC_CHECK` was [introduced](https://github.com/catchorg/Catch2/pull/2318) in Catch2 X.Y.Z. +> `STATIC_CHECK` was [introduced](https://github.com/catchorg/Catch2/pull/2318) in Catch2 3.0.1. `STATIC_CHECK( expr )` is equivalent to `STATIC_REQUIRE( expr )`, with the difference that when `CATCH_CONFIG_RUNTIME_STATIC_REQUIRE` is defined, it diff --git a/docs/release-notes.md b/docs/release-notes.md index 1b0188b4..3a5de276 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2,7 +2,7 @@ # Release notes **Contents**<br> -[3.0.1 (in progress)](#301-in-progress)<br> +[3.0.1](#301)<br> [2.13.7](#2137)<br> [2.13.6](#2136)<br> [2.13.5](#2135)<br> @@ -49,7 +49,7 @@ [Even Older versions](#even-older-versions)<br> -## 3.0.1 (in progress) +## 3.0.1 **Catch2 now uses statically compiled library as its distribution model. This also means that to get all of Catch2's functionality in a test file, @@ -206,6 +206,7 @@ v3 releases. * The cumulative reporter base stores benchmark results alongside assertion results * Catch2's SE handling should no longer interferes with ASan on Windows (#2334) * Fixed Windows console colour handling for tests that redirect stdout (#2345) +* Fixed issue with the `random` generators returning the same value over and over again ### Other changes @@ -230,6 +231,7 @@ v3 releases. * `-DCATCH_CONFIG_ANDROID_LOGWRITE=OFF` does nothing (the define will not exist) + ## 2.13.7 ### Fixes diff --git a/docs/reporter-events.md b/docs/reporter-events.md index 3641656a..7adae53c 100644 --- a/docs/reporter-events.md +++ b/docs/reporter-events.md @@ -56,7 +56,7 @@ are handled by a different event. ### `testCasePartial` events -> Introduced in Catch2 X.Y.Z +> Introduced in Catch2 3.0.1 ```cpp void testCasePartialStarting( TestCaseInfo const& testInfo, uint64_t partNumber ); @@ -135,7 +135,7 @@ benchmarking itself fails. ## Listings events -> Introduced in Catch2 X.Y.Z. +> Introduced in Catch2 3.0.1. Listings events are events that correspond to the test binary being invoked with `--list-foo` flag. diff --git a/docs/reporters.md b/docs/reporters.md index 5f86b02e..496c61a9 100644 --- a/docs/reporters.md +++ b/docs/reporters.md @@ -30,7 +30,7 @@ reporters](#multiple-reporters) to avoid any surprises from doing so. <a id="multiple-reporters"></a> ## Using multiple reporters -> Support for having multiple parallel reporters was [introduced](https://github.com/catchorg/Catch2/pull/2183) in Catch2 X.Y.Z +> Support for having multiple parallel reporters was [introduced](https://github.com/catchorg/Catch2/pull/2183) in Catch2 3.0.1 Catch2 supports using multiple reporters at the same time while having them write into different destinations. The two main uses of this are @@ -169,7 +169,7 @@ Currently there are two customization options: ### Per-reporter configuration -> Per-reporter configuration was introduced in Catch2 X.Y.Z +> Per-reporter configuration was introduced in Catch2 3.0.1 Catch2 supports some configuration to happen per reporter. The configuration options fall into one of two categories: |