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

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2025-07-20 21:40:18 +0200
committerMartin Hořeňovský2025-07-21 21:50:43 +0200
commit8c3ffe05e1293e64c8d10bcd68092fe9de9673ff (patch)
tree6149e88b69977fbf331f2742f06ea63bd0390b3f /docs
parent715558fd97a48533fd41cb7dddf23b05d333cec6 (diff)
downloadcatch3-8c3ffe05e1293e64c8d10bcd68092fe9de9673ff.tar.gz
Skeleton for applying deprecation warnings
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index f268ba50..182606ea 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -263,6 +263,21 @@ namespace Catch {
}
```
+
+## Disabling deprecation warnings
+
+> Introduced in Catch2 X.Y.Z
+
+Catch2 has started using the C++ macro `[[deprecated]]` to mark things
+that are deprecated and should not be used any more. If you need to
+temporarily disable these warnings, use
+
+ CATCH_CONFIG_NO_DEPRECATION_ANNOTATIONS
+
+Catch2 currently does not support more fine-grained deprecation warning
+control, nor do we plan to.
+
+
## Overriding Catch's debug break (`-b`)
> [Introduced](https://github.com/catchorg/Catch2/pull/1846) in Catch2 2.11.2.