Skip to content

Update docs v3 #3046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: devel
Choose a base branch
from
+7 −7
Open

Update docs v3 #3046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dbaaac4
Update contributing.md to reflect v3 as main version
Nov 17, 2025
c07d416
Improve migration instructions for v3
Nov 17, 2025
1068823
Fix outdated include references in release notes
Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/migrate-v2-to-v3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <catch2/catch.hpp>` to `#include <catch2/catch_all.hpp>`
4. Check that everything compiles. You might have to modify namespaces,
or perform some other changes (see the
Expand Down
6 changes: 3 additions & 3 deletions docs/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <catch2/catch.hpp>`
* If you use them, the new include path is `#include <catch2/catch_all.hpp>`
* 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`
Expand Down Expand Up @@ -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 <catch.hpp>`(#1239)
* The plans to standardize on `#include <catch2/catch.hpp>` are still in effect
* Modified CMake-installed pkg-config to allow `#include <catch2/catch_all.hpp>`(#1239)
* The plans to standardize on `#include <catch2/catch_all.hpp>` are still in effect


## 2.2.1
Expand Down