From dbaaac48279e8f2c9ff8624c3ee0f02828159696 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Garz=C3=B3n?= Date: Sun, 16 Nov 2025 23:14:06 -0500 Subject: [PATCH 1/3] Update contributing.md to reflect v3 as main version - Clarify that v2.x is in maintenance mode only - Remove implication of active v2.x development Addresses #2050 --- docs/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index d21323d991..ef7fc0c356 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -21,8 +21,8 @@ to the codebase itself. ## Using Git(Hub) -Ongoing development happens in the `devel` branch for Catch2 v3, and in -`v2.x` for maintenance updates to the v2 versions. +Ongoing development happens in the `devel` branch for Catch2 v3. +The `v2.x` branch is in maintenance mode for critical fixes only. Commits should be small and atomic. A commit is atomic when, after it is applied, the codebase, tests and all, still works as expected. Small From c07d4166820b88855afafbcc3138ab57a0c229d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Garz=C3=B3n?= Date: Sun, 16 Nov 2025 23:30:14 -0500 Subject: [PATCH 2/3] Improve migration instructions for v3 - Clarify 'Delete TU' instruction to be less destructive - Emphasize removing definitions rather than deleting files Addresses #2050 --- docs/migrate-v2-to-v3.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/migrate-v2-to-v3.md b/docs/migrate-v2-to-v3.md index 84ed76904a..98fa732f6e 100644 --- a/docs/migrate-v2-to-v3.md +++ b/docs/migrate-v2-to-v3.md @@ -53,8 +53,8 @@ compilation times in the v3 version. The basic steps to do so are: you use Catch2's default main. (If you do not, keep linking against the `Catch2` target.). If you use pkg-config, change `pkg-config catch2` to `pkg-config catch2-with-main`. -2. Delete TU with `CATCH_CONFIG_RUNNER` or `CATCH_CONFIG_MAIN` defined, -as it is no longer needed. +2. Remove `CATCH_CONFIG_RUNNER` or `CATCH_CONFIG_MAIN` definitions from your code, +as they are no longer needed in v3. 3. Change `#include ` to `#include ` 4. Check that everything compiles. You might have to modify namespaces, or perform some other changes (see the From 1068823c94cbb374883176ce8b23b360e86ad3f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isabella=20Garz=C3=B3n?= Date: Sun, 16 Nov 2025 23:39:10 -0500 Subject: [PATCH 3/3] Fix outdated include references in release notes - Update catch.hpp references to catch_all.hpp for v3 compatibility - Ensure historical documentation reflects current include structure Addresses #2050 --- docs/release-notes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/release-notes.md b/docs/release-notes.md index 9da1a2e177..d3c21140f1 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1369,7 +1369,7 @@ than `single_include/catch.hpp`.** ### Improvements * pkg-config and CMake integration has been rewritten - * If you use them, the new include path is `#include ` + * If you use them, the new include path is `#include ` * CMake installation now also installs scripts from `contrib/` * For details see the [new documentation](cmake-integration.md#top) * Reporters now have a new customization point, `ReporterPreferences::shouldReportAllAssertions` @@ -1438,8 +1438,8 @@ than `single_include/catch.hpp`.** * See [documentation for details](https://github.com/catchorg/Catch2/blob/devel/docs/matchers.md) ### Others -* Modified CMake-installed pkg-config to allow `#include `(#1239) - * The plans to standardize on `#include ` are still in effect +* Modified CMake-installed pkg-config to allow `#include `(#1239) +* The plans to standardize on `#include ` are still in effect ## 2.2.1