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

summaryrefslogtreecommitdiffhomepage
path: root/docs/usage-tips.md
diff options
context:
space:
mode:
authorLeitwolf2026-10-25 10:31:36 +0300
committerGitHub2026-10-25 10:31:36 +0300
commitd2e3e074bb2e1b8ffd9fc990d0b87667ea602f58 (patch)
tree0bce4462b2e190c39b3e1c5f697e3e4abd1a5e2a /docs/usage-tips.md
parent13f81a480a93807c14dddb5abdb97355ced4d4c5 (diff)
parent126dc333564cb72b5115d9a9242d66694694b6d0 (diff)
downloadcatch3-d2e3e074bb2e1b8ffd9fc990d0b87667ea602f58.tar.gz
Merge pull request #18 from Progmasoft/build/catch3-identity
Give Catch3 its own build names and headers
Diffstat (limited to 'docs/usage-tips.md')
-rw-r--r--docs/usage-tips.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/usage-tips.md b/docs/usage-tips.md
index 18e9cd11..b11aee5f 100644
--- a/docs/usage-tips.md
+++ b/docs/usage-tips.md
@@ -1,6 +1,6 @@
<a id="top"></a>
-> **Catch3 compatibility reference:** This page describes the bundled Catch2-compatible API. Names such as `Catch2`, `catch2/`, and `Catch2::Catch2WithMain` remain where they are actual compatibility interfaces. See [Catch3 additions](progmasoft-catch3.md) for Progmasoft APIs.
+> **Catch3 compatibility reference:** This page describes the test-writing API Catch3 shares with Catch2: the macros, such as `TEST_CASE` and `REQUIRE`, and the `Catch::` namespace keep Catch2's names. Headers and build names are Catch3's own (`<Progmasoft/Catch3/TestMacros.hpp>`, `find_package(Catch3)`, `Catch3::Catch3WithMain`). See [Catch3 additions](progmasoft-catch3.md) for Progmasoft APIs.
# Best practices for the Catch3 compatibility API
@@ -44,9 +44,9 @@ cover every test exactly once whatever the order or seed of each run. With
`--shard-durations=FILE`, a JSON report or history of an earlier run, the
shards are balanced by duration instead.
-If you use CMake and CTest, [`catch_discover_tests`](cmake-integration.md#automatic-test-registration)
+If you use CMake and CTest, [`catch3_discover_tests`](cmake-integration.md#automatic-test-registration)
registers each `TEST_CASE` as a CTest test, and
-[`CatchShardTests.cmake`](cmake-integration.md#catchshardtestscmake)
+[`Catch3ShardTests.cmake`](cmake-integration.md#catchshardtestscmake)
registers shards.