3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-26 07:16:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve v2->v3 migration docs

Browse Source
This commit is contained in:
Martin Hořeňovský 2022-08-18 00:02:33 +02:00
parent 47d56f28a9
commit ab04e599e7
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/migrate-v2-to-v3.md
View File

@ -65,7 +65,9 @@ to piecemeal includes. You will likely want to start by including
[other notes](#other-notes) for further ideas) [other notes](#other-notes) for further ideas)
## Other notes ## Other notes
* The main test include is now `<catch2/catch_test_macros.hpp>` * The main test include is now `<catch2/catch_test_macros.hpp>`
* Big "subparts" like Matchers, or Generators, have their own folder, and * Big "subparts" like Matchers, or Generators, have their own folder, and
also their own "big header", so if you just want to include all matchers, also their own "big header", so if you just want to include all matchers,
you can include `<catch2/matchers/catch_matchers_all.hpp>`, you can include `<catch2/matchers/catch_matchers_all.hpp>`,
@ -73,11 +75,21 @@ or `<catch2/generators/catch_generators_all.hpp>`
## Things that can break during porting ## Things that can break during porting
* The namespace on Matchers were cleaned up, they are no longer first declared
deep within an internal namespace and then brought up. All Matchers now live * The namespaces of Matchers were flattened and cleaned up.
in `Catch::Matchers`.
* The reporter interfaces changed in a breaking manner. If you wrote custom Matchers are no longer declared deep within an internal namespace and
reporter or listener, you might need to modify them a bit. then brought up into `Catch` namespace. All Matchers now live in the
`Catch::Matchers` namespace.
* The `Contains` string matcher was renamed to `ContainsSubstring`.
* The reporter interfaces changed in a breaking manner.
If you are using a custom reporter or listener, you will likely need to
modify them to conform to the new interfaces. Unlike before in v2,
the [interfaces](reporters.md#top) and the [events](reporter-events.md#top)
are now documented.
--- ---