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

summaryrefslogtreecommitdiffhomepage
path: root/docs/release-notes.md
diff options
context:
space:
mode:
authorLeitwolf112026-10-25 02:37:35 +0300
committerLeitwolf112026-10-25 02:37:35 +0300
commit126dc333564cb72b5115d9a9242d66694694b6d0 (patch)
tree0bce4462b2e190c39b3e1c5f697e3e4abd1a5e2a /docs/release-notes.md
parent13f81a480a93807c14dddb5abdb97355ced4d4c5 (diff)
downloadcatch3-126dc333564cb72b5115d9a9242d66694694b6d0.tar.gz
Give Catch3 its own build names and headers
Catch2 compatibility means the API tests are written in: the macros, such as TEST_CASE and REQUIRE, and the Catch:: namespace. It does not mean Catch2's build names or header paths. find_package(Catch2) found Catch3, and a project using both frameworks met two packages, two sets of targets, two Catch.cmake modules and two catch2/ header trees with the same names. Build names: - CMake: project and package Catch3, targets Catch3::Catch3 and Catch3::Catch3WithMain, libraries Catch3 and Catch3Main, options CATCH3_*, lib/cmake/Catch3 with Catch3Config, and pkg-config catch3 and catch3-with-main. The version is Catch3's, 0.3.0, compatible within a minor version. - The CMake scripts are Catch3.cmake (catch3_discover_tests), Catch3AddTests.cmake and Catch3ShardTests.cmake (catch3_add_sharded_tests); the helpers they define at ctest time have a catch3_ prefix. ParseAndAddCatchTests.cmake, deprecated upstream, is gone. - Bazel //:catch3 and //:catch3_main, Meson catch3 and catch3-with-main (with override_dependency), Xmake catch3 and catch3_main, Premake Catch3 and Catch3WithMain. Visual Studio projects get GUIDs of their own. - The Progmasoft::Catch3 target and package are gone: property testing and snapshots are part of Catch3::Catch3. Their sources now build with the library's warning flags, so property failures are built field by field (no missing initializers) and the default property name is a thread-local pointer to the name its scope owns (no global destructor). Headers: the engine moved from src/catch2 to src/Progmasoft/Catch3 with Progmasoft names, so <catch2/catch_test_macros.hpp> is <Progmasoft/Catch3/TestMacros.hpp>, <catch2/matchers/catch_matchers_string.hpp> is <Progmasoft/Catch3/Matchers/String.hpp>, and interface headers are named after their interface, such as Interfaces/IConfig.hpp. Include guards became #pragma once. The installed headers go to include/Progmasoft. src/Progmasoft/Context.cpp is StrategyContext.cpp, so no two sources share a file name. tools/scripts/upstreamFiles.txt lists the files that come from Catch2. The license check expects BSL-1.0 on them and Progmasoft's header on the rest of src/Progmasoft; the convenience-header check, the amalgamation script and the surrogate tests take the engine's headers from it. The amalgamated files are regenerated. The header-guard workflow checks for #pragma once instead of checkguard. Documents, the README and the release notes describe the new names.
Diffstat (limited to 'docs/release-notes.md')
-rw-r--r--docs/release-notes.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 9f5a1b31..3dd4ca66 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -36,10 +36,25 @@ line and reporters with [a runner of its own](progmasoft-runner.md#top):
### Breaking changes
+* Catch3 has its own build and header names, so that it is never mistaken
+ for Catch2 and both can be used in one project:
+ * CMake: `find_package(Catch3)` with `Catch3::Catch3` and
+ `Catch3::Catch3WithMain`, options `CATCH3_*`, and the scripts
+ `Catch3.cmake` (`catch3_discover_tests`) and `Catch3ShardTests.cmake`
+ (`catch3_add_sharded_tests`). The `Progmasoft::Catch3` target is gone:
+ its code is part of `Catch3::Catch3`.
+ * Bazel `//:catch3` and `//:catch3_main`, Meson `catch3` and
+ `catch3-with-main`, pkg-config `catch3.pc` and `catch3-with-main.pc`.
+ * Headers moved from `catch2/` to `Progmasoft/Catch3/` with Progmasoft
+ names: `<catch2/catch_test_macros.hpp>` is
+ `<Progmasoft/Catch3/TestMacros.hpp>`, `<catch2/matchers/catch_matchers_string.hpp>`
+ is `<Progmasoft/Catch3/Matchers/String.hpp>`, and so on. Test bodies do
+ not change: the macros and the `Catch::` namespace keep their names.
+ * `ParseAndAddCatchTests.cmake`, deprecated upstream, was removed.
* Catch2's command line, reporters, `CATCH_REGISTER_REPORTER` and listing
were removed; see [the command line](command-line.md#top) and
[reports](reporters.md#top). Listeners keep working.
-* The Catch2 library is compiled as C++20; code that includes only its
+* The library is compiled as C++20; code that includes only the engine's
headers still needs C++14.
* The results model in `Progmasoft/Catch3/Results.hpp` was rewritten around
tests and attempts.