diff options
| author | Martin Hořeňovský | 2019-10-13 23:44:18 +0200 |
|---|---|---|
| committer | Martin Hořeňovský | 2019-10-13 23:44:18 +0200 |
| commit | 7c9f92bc1c6e82ad5b6af8dff9f97af880fae9c6 (patch) | |
| tree | d8bc58457176ac973c4a4c8f60c34cdb154af151 /docs | |
| parent | a92a7d02290eae896413a7d96e4875587c0dcd42 (diff) | |
| download | catch3-2.10.0.tar.gz | |
v2.10.0v2.10.0
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.md | 2 | ||||
| -rw-r--r-- | docs/generators.md | 4 | ||||
| -rw-r--r-- | docs/matchers.md | 4 | ||||
| -rw-r--r-- | docs/release-notes.md | 45 |
4 files changed, 50 insertions, 5 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index ec042c23..599bb9ae 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -158,7 +158,7 @@ by using `_NO_` in the macro, e.g. `CATCH_CONFIG_NO_CPP17_UNCAUGHT_EXCEPTIONS`. CATCH_CONFIG_ANDROID_LOGWRITE // Use android's logging system for debug output CATCH_CONFIG_GLOBAL_NEXTAFTER // Use nextafter{,f,l} instead of std::nextafter -> [`CATCH_CONFIG_ANDROID_LOGWRITE`](https://github.com/catchorg/Catch2/issues/1743) and [`CATCH_CONFIG_GLOBAL_NEXTAFTER`](https://github.com/catchorg/Catch2/pull/1739) were introduced in Catch X.Y.Z +> [`CATCH_CONFIG_ANDROID_LOGWRITE`](https://github.com/catchorg/Catch2/issues/1743) and [`CATCH_CONFIG_GLOBAL_NEXTAFTER`](https://github.com/catchorg/Catch2/pull/1739) were introduced in Catch 2.10.0 Currently Catch enables `CATCH_CONFIG_WINDOWS_SEH` only when compiled with MSVC, because some versions of MinGW do not have the necessary Win32 API support. diff --git a/docs/generators.md b/docs/generators.md index 34565a50..61276f3c 100644 --- a/docs/generators.md +++ b/docs/generators.md @@ -54,7 +54,7 @@ a test case, > `ChunkGenerator<T>`, `RandomIntegerGenerator<Integral>`, `RandomFloatGenerator<Float>` and `RangeGenerator<T>` were introduced in Catch 2.7.0. -> `IteratorGenerator<T>` was introduced in Catch X.Y.Z. +> `IteratorGenerator<T>` was introduced in Catch 2.10.0. The generators also have associated helper functions that infer their type, making their usage much nicer. These are @@ -76,7 +76,7 @@ type, making their usage much nicer. These are > `chunk()`, `random()` and both `range()` functions were introduced in Catch 2.7.0. -> `from_range` has been introduced in Catch X.Y.Z +> `from_range` has been introduced in Catch 2.10.0 And can be used as shown in the example below to create a generator that returns 100 odd random number: diff --git a/docs/matchers.md b/docs/matchers.md index f10ae918..af2071e3 100644 --- a/docs/matchers.md +++ b/docs/matchers.md @@ -90,7 +90,7 @@ the helpers for this matcher, `WithinRel(double target, double margin)`, `WithinRel(float target)`. The latter two provide a default epsilon of machine epsilon * 100. -> `WithinRel` matcher was introduced in Catch X.Y.Z +> `WithinRel` matcher was introduced in Catch 2.10.0 ### Generic matchers Catch also aims to provide a set of generic matchers. Currently this set @@ -120,7 +120,7 @@ is `ExceptionMessageMatcher`, and we also provide a helper function The matched exception must publicly derive from `std::exception` and the message matching is done _exactly_, including case. -> `ExceptionMessageMatcher` was introduced in Catch X.Y.Z +> `ExceptionMessageMatcher` was introduced in Catch 2.10.0 Example use: ```cpp diff --git a/docs/release-notes.md b/docs/release-notes.md index 204cea34..0af35c67 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -2,6 +2,7 @@ # Release notes **Contents**<br> +[2.10.0](#2100)<br> [2.9.2](#292)<br> [2.9.1](#291)<br> [2.9.0](#290)<br> @@ -28,6 +29,50 @@ [Even Older versions](#even-older-versions)<br> + +## 2.10.0 + +### Fixes +* `TEMPLATE_LIST_TEST_CASE` now properly handles non-copyable and non-movable types (#1729) +* Fixed compilation error on Solaris caused by a system header defining macro `TT` (#1722, #1723) +* `REGISTER_ENUM` will now fail at compilation time if the registered enum is too large +* Removed use of `std::is_same_v` in C++17 mode (#1757) +* Fixed parsing of escaped special characters when reading test specs from a file (#1767, #1769) + + +### Improvements +* Trailing and leading whitespace in test/section specs are now ignored. +* Writing to Android debug log now uses `__android_log_write` instead of `__android_log_print` +* Android logging support can now be turned on/off at compile time (#1743) + * The toggle is `CATCH_CONFIG_ANDROID_LOGWRITE` +* Added a generator that returns elements of a range + * Use via `from_range(from, to)` or `from_range(container)` +* Added support for CRTs that do not provide `std::nextafter` (#1739) + * They must still provide global `nextafter{f,l,}` + * Enabled via `CATCH_CONFIG_GLOBAL_NEXTAFTER` +* Special cased `Approx(inf)` not to match non-infinite values + * Very strictly speaking this might be a breaking change, but it should match user expectations better +* The output of benchmarking through the Console reporter when `--benchmark-no-analysis` is set is now much simpler (#1768) +* Added a matcher that can be used for checking an exceptions message (#1649, #1728) + * The matcher helper function is called `Message` + * The exception must publicly derive from `std::exception` + * The matching is done exactly, including case and whitespace +* Added a matcher that can be used for checking relative equality of floating point numbers (#1746) + * Unlike `Approx`, it considers both sides when determining the allowed margin + * Special cases `NaN` and `INFINITY` to match user expectations + * The matcher helper function is called `WithinRel` +* The ULP matcher now allows for any possible distance between the two numbers +* The random number generators now use Catch-global instance of RNG (#1734, #1736) + * This means that nested random number generators actually generate different numbers + + +### Miscellaneous +* In-repo PNGs have been optimized to lower overhead of using Catch2 via git clone +* Catch2 now uses its own implementation of the URBG concept + * In the future we also plan to use our own implementation of the distributions from `<random>` to provide cross-platform repeatability of random results + + + ## 2.9.2 ### Fixes |