catch2/docs/deprecations.md

<a id="top"></a>
# Deprecations and incoming changes

This page documents current deprecations and upcoming planned changes
inside Catch2. The difference between these is that a deprecated feature
will be removed, while a planned change to a feature means that the
feature will behave differently, but will still be present. Obviously,
either of these is a breaking change, and thus will not happen until
at least the next major release.


### `ParseAndAddCatchTests.cmake`

The CMake/CTest integration using `ParseAndAddCatchTests.cmake` is deprecated,
as it can be replaced by `Catch.cmake` that provides the function
`catch_discover_tests` to get tests directly from a CMake target via the
command line interface instead of parsing C++ code with regular expressions.


## Planned changes

### Console Colour API

The API for Catch2's console colour will be changed to take an extra
argument, the stream to which the colour code should be applied.


---

[Home](Readme.md#top)
Add deprecations documentation 2018-11-17 11:01:29 +01:00			`<a id="top"></a>`
			`# Deprecations and incoming changes`

Turn "deprecations" into "deprecations and planned changes" This captures the intent better, as some changes are indeed plain deprecations leading to removal, but other changes can be viewed as minor tune-ups instead. 2018-11-24 18:01:20 +01:00			`This page documents current deprecations and upcoming planned changes`
			`inside Catch2. The difference between these is that a deprecated feature`
			`will be removed, while a planned change to a feature means that the`
			`feature will behave differently, but will still be present. Obviously,`
			`either of these is a breaking change, and thus will not happen until`
			`at least the next major release.`
Add deprecations documentation 2018-11-17 11:01:29 +01:00

Add deprecation warning in ParseAndCatchTests Parsing C++ with regex in CMake is error prone and regularly leads to silently dropped (not run) test cases. Going forward the function `catch_discover_tests` from `contrib/CMake.cmake` should be used. For more information see https://github.com/catchorg/Catch2/issues/2092#issuecomment-747342765 2020-12-17 14:02:48 +01:00			### `ParseAndAddCatchTests.cmake`

			The CMake/CTest integration using `ParseAndAddCatchTests.cmake` is deprecated,
			as it can be replaced by `Catch.cmake` that provides the function
			`catch_discover_tests` to get tests directly from a CMake target via the
			`command line interface instead of parsing C++ code with regular expressions.`

Fix significant bug with storing composed matchers Given that in the 2 or so years that matchers are thing nobody complained, it seems that people do not actually write this sort of code, and the possibility will be removed in v3. However, to avoid correctness bugs, we will have to support this weird code in v2. 2020-02-01 20:55:42 +01:00
Turn "deprecations" into "deprecations and planned changes" This captures the intent better, as some changes are indeed plain deprecations leading to removal, but other changes can be viewed as minor tune-ups instead. 2018-11-24 18:01:20 +01:00			`## Planned changes`
Add more deprecations 2018-11-17 21:13:56 +01:00
Fix colourized output to file This change should be backwards compatible, but it would be better to make the console colour API take an argument in the long term. Fixes #1502 2019-01-19 13:29:53 +01:00			`### Console Colour API`

			`The API for Catch2's console colour will be changed to take an extra`
			`argument, the stream to which the colour code should be applied.`

Mark type erasure in PredicateFunction as deprecated 2019-10-28 15:14:54 +01:00
Add deprecations documentation 2018-11-17 11:01:29 +01:00			`---`

			`[Home](Readme.md#top)`