Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2022-07-17 20:18:44 +0200
committerMartin Hořeňovský2022-07-17 20:18:44 +0200
commit97c48e0c343d26d50764fafdc90b1e630fbd10ce (patch)
tree2409658cbaf9d5a441ebe270836732aea5a6ffa2 /docs
parent9c9f35068edaa1290789c56f241fc54e7de0eeb0 (diff)
downloadcatch3-3.1.0.tar.gz
v3.1.0v3.1.0
Diffstat (limited to 'docs')
-rw-r--r--docs/cmake-integration.md2
-rw-r--r--docs/configuration.md2
-rw-r--r--docs/release-notes.md40
3 files changed, 42 insertions, 2 deletions
diff --git a/docs/cmake-integration.md b/docs/cmake-integration.md
index 9637be9b..dc3efc9d 100644
--- a/docs/cmake-integration.md
+++ b/docs/cmake-integration.md
@@ -262,7 +262,7 @@ ParseAndAddCatchTests(bar)
### `CatchShardTests.cmake`
-> `CatchShardTests.cmake` was introduced in Catch2 X.Y.Z.
+> `CatchShardTests.cmake` was introduced in Catch2 3.1.0.
`CatchShardTests.cmake` provides a function
`catch_add_sharded_tests(TEST_BINARY)` that splits tests from `TEST_BINARY`
diff --git a/docs/configuration.md b/docs/configuration.md
index d857e792..9fd7f58b 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -103,7 +103,7 @@ Catch2 will register a `JUnit` reporter writing to a path pointed by `XML_OUTPUT
> `CATCH_CONFIG_BAZEL_SUPPORT` was [introduced](https://github.com/catchorg/Catch2/pull/2399) in Catch2 3.0.1.
-> `CATCH_CONFIG_BAZEL_SUPPORT` was [deprecated](https://github.com/catchorg/Catch2/pull/2459) in Catch2 X.Y.Z.
+> `CATCH_CONFIG_BAZEL_SUPPORT` was [deprecated](https://github.com/catchorg/Catch2/pull/2459) in Catch2 3.1.0.
## C++11 toggles
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 3a5de276..da2c598c 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -2,6 +2,7 @@
# Release notes
**Contents**<br>
+[3.1.0](#310)<br>
[3.0.1](#301)<br>
[2.13.7](#2137)<br>
[2.13.6](#2136)<br>
@@ -49,6 +50,45 @@
[Even Older versions](#even-older-versions)<br>
+## 3.1.0
+
+### Improvements
+* Improved suppression of `-Wparentheses` for older GCCs
+ * Turns out that even GCC 9 does not properly handle `_Pragma`s in the C++ frontend.
+* Added type constraints onto `random` generator (#2433)
+ * These constraints copy what the standard says for the underlying `std::uniform_int_distribution`
+* Suppressed -Wunused-variable from nvcc (#2306, #2427)
+* Suppressed -Wunused-variable from MinGW (#2132)
+* Added All/Any/NoneTrue range matchers (#2319)
+ * These check that all/any/none of boolean values in a range are true.
+* The JUnit reporter now normalizes classnames from C++ namespaces to Java-like namespaces (#2468)
+ * This provides better support for other JUnit based tools.
+* The Bazel support now understands `BAZEL_TEST` environment variable (#2459)
+ * The `CATCH_CONFIG_BAZEL_SUPPORT` configuration option is also still supported.
+* Returned support for compiling Catch2 with GCC 5 (#2448)
+ * This required removing inherited constructors from Catch2's internals.
+ * I recommend updating to a newer GCC anyway.
+* `catch_discover_tests` now has a new options for setting library load path(s) when running the Catch2 binary (#2467)
+
+
+### Fixes
+* Fixed crash when listing listeners without any registered listeners (#2442)
+* Fixed nvcc compilation error in constructor benchmarking helper (#2477)
+* Catch2's CMakeList supports pre-3.12 CMake again (#2428)
+ * The gain from requiring CMake 3.12 was very minor, but y'all should really update to newer CMake
+
+
+### Miscellaneous
+* Fixed SelfTest build on MinGW (#2447)
+* The in-repo conan recipe exports the CMake helper (#2460)
+* Added experimental CMake script to showcase using test case sharding together with CTest
+ * Compared to `catch_discover_tests`, it supports very limited number of options and customization
+* Added documentation page on best practices when running Catch2 tests
+* Catch2 can be built as a dynamic library (#2397, #2398)
+ * Note that Catch2 does not have visibility annotations, and you are responsible for ensuring correct visibility built into the resulting library.
+
+
+
## 3.0.1
**Catch2 now uses statically compiled library as its distribution model.