Skip to content

Commit dbf6bb5

Browse files
committed
Add deprecation notice for Catch-related items
1 parent 8a92770 commit dbf6bb5

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

Diff for: README.md

+2
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,8 @@ The given doxygen file to use/process. (Defaults to'${CMAKE_CURRENT_SOURCE_DIR}/
321321

322322
## Prepare the Catch Test Framework [`prepare-catch.cmake`](prepare-catch.cmake)
323323

324+
**DEPRECATED**: Catch now has good CMake integration available natively, so this is no longer required and will be dropped in a future release.
325+
324326
The included `prepare_catch` function contained within attempts to add the infrastructure necessary for automatically adding C/C++ tests using the Catch2 library, including either an interface or pre-compiled 'catch' target library.
325327

326328
It first attempts to find the header on the local machine, and failing that, clones the single header variant for use. It does make the determination between pre-C++11 and will use Catch1.X rather than Catch2 (when cloned), automatically or forced.. Adds a subdirectory of tests/ if it exists from the macro's calling location.

Diff for: prepare-catch.cmake

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ option(FORCE_CATCH_CLONE
2121
find_file(HAVE_CATCH_HPP catch.hpp PATH_SUFFIXES catch2 catch)
2222
mark_as_advanced(FORCE HAVE_CATCH_HPP)
2323

24+
# **DEPRECATED** Catch now has proper CMake integration, and this will be dropped
25+
# in a future release.
26+
#
2427
# Attempts to add the infrastructure necessary for automatically adding C/C++
2528
# tests using the Catch2 library, including either an interface or pre-compiled
2629
# 'catch' target library.

0 commit comments

Comments
 (0)