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

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorRiom2023-07-19 17:04:43 +0200
committerGitHub2023-07-19 17:04:43 +0200
commit4acc51828f7f93f3b2058a63f54d112af4034503 (patch)
tree5c24042a87d9a9f711e8a7dc3cca5ff4cbfd4921 /docs
parent6e79e682b726f524310d55dec8ddac4e9c52fb5f (diff)
downloadcatch3-4acc51828f7f93f3b2058a63f54d112af4034503.tar.gz
Introduce CATCH_CONFIG_PREFIX_MESSAGES to only prefix a few logging related macros. (#2544)
* Add missing include for VxWorks build. std::min is defined in algorithm provides std::min. It appears to be transitively included for most platforms. For VxWorks however this explicit include is required. * Add option CATCH_CONFIG_PREFIX_MESSAGES to selectively prefix message macros only. In contrast to CATCH_CONFIG_PREFIX_ALL, this will only prefix the following macros: I.e. INFO, UNSCOPED_INFO, WARN and CATCH_CAPTURE This is mainly useful for codebases that use INFO or WARN for their own logging macros.
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 49b8ed9d..8a3ddfab 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -26,7 +26,8 @@ with the same name.
## Prefixing Catch macros
- CATCH_CONFIG_PREFIX_ALL
+ CATCH_CONFIG_PREFIX_ALL // Prefix all macros with CATCH_
+ CATCH_CONFIG_PREFIX_MESSAGES // Prefix only INFO, UNSCOPED_INFO, WARN and CAPTURE
To keep test code clean and uncluttered Catch uses short macro names (e.g. ```TEST_CASE``` and ```REQUIRE```). Occasionally these may conflict with identifiers from platform headers or the system under test. In this case the above identifier can be defined. This will cause all the Catch user macros to be prefixed with ```CATCH_``` (e.g. ```CATCH_TEST_CASE``` and ```CATCH_REQUIRE```).