Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorLeitwolf112026-11-01 00:25:59 +0300
committerLeitwolf112026-11-01 00:25:59 +0300
commitff1da91edffa9ee887e9fe737fcd87ec540dfa60 (patch)
tree25841e888932ebac3a51c4b59f77cea5a87ae5bd /docs
parent42c68725c816963ec6529dd635d5aaaac23b1c05 (diff)
downloadcatch3-chore/cpp17-descriptions.tar.gz
Say C++17 everywhere the project describes itselfchore/cpp17-descriptions
The move to C++17 left a trail of older claims. The Runner's own .clang-format still said c++20; the result is byte for byte the same under either value. Premake and Xmake still compiled the library as C++20 and the main library as C++14, which meant their CI jobs were not testing the language the project promises. Both now use C++17 for every target. The rest is text: the Meson pkg-config description claimed C++14, comments in the CMake and Meson files explained requirements that no longer exist, .clang-tidy gave C++14 as the reason for two exclusions, issue templates asked for C++20 samples, and the example headers named -std=c++14 and catch2-with-main. The release notes and the migration guide state the C++17 minimum. Doxygen's brief called the project "Catch2's test API", which presents it as Catch2. Meson declared only BSL-1.0; it now names both licenses of the tree. The amalgamated files are regenerated.
Diffstat (limited to 'docs')
-rw-r--r--docs/migrate-v2-to-v3.md2
-rw-r--r--docs/release-notes.md3
2 files changed, 2 insertions, 3 deletions
diff --git a/docs/migrate-v2-to-v3.md b/docs/migrate-v2-to-v3.md
index bd030523..9ec1f1c7 100644
--- a/docs/migrate-v2-to-v3.md
+++ b/docs/migrate-v2-to-v3.md
@@ -7,7 +7,7 @@
v3 is the next major version of Catch2 and brings three significant changes:
* Catch2 is now split into multiple headers
* Catch2 is now compiled as a static library
- * C++14 is the minimum required C++ version
+ * C++17 is the minimum required C++ version
There are many reasons why we decided to go from the old single-header
distribution model to a more standard library distribution model. The
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 870541d4..0e3633de 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -71,8 +71,7 @@ line and reporters with [a runner of its own](progmasoft-runner.md#top):
* Catch2's command line, reporters, `CATCH_REGISTER_REPORTER` and listing
were removed; see [the command line](command-line.md#top) and
[reports](reporters.md#top). Listeners keep working.
-* The library is compiled as C++20; code that includes only the engine's
- headers still needs C++14.
+* C++17 is the minimum, for the library and for the code that uses it.
* The results model in `Progmasoft/Catch3/Results.hpp` was rewritten around
tests and attempts.
* Conan packaging was dropped.