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

summaryrefslogtreecommitdiffhomepage
path: root/docs/contributing.md
diff options
context:
space:
mode:
authorMartin Hořeňovský2022-11-09 16:32:43 +0100
committerMartin Hořeňovský2022-11-09 16:33:47 +0100
commit066cc51ce657a3d787ec228e8af22830a92723fc (patch)
tree792f9efb654554b4955a4ee3c72c3866d3ba37d7 /docs/contributing.md
parentb7f4a2efb808e8d154874e168cec8e0aaf70bd06 (diff)
downloadcatch3-066cc51ce657a3d787ec228e8af22830a92723fc.tar.gz
Document adding new CATCH_CONFIG options to contributing.md
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 64e6fa8b..d1df872a 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -303,6 +303,18 @@ be `CATCH_MATCHERS_FOO_HPP_INCLUDED`, for `catch_generators_bar.hpp`, the includ
guard should be `CATCH_GENERATORS_BAR_HPP_INCLUDED`, and so on.
+### Adding new `CATCH_CONFIG` option
+
+When adding new `CATCH_CONFIG` option, there are multiple places to edit:
+ * `CMake/CatchConfigOptions.cmake` - this is used to generate the
+ configuration options in CMake, so that CMake frontends know about them.
+ * `docs/configuration.md` - this is where the options are documented
+ * `src/catch2/catch_user_config.hpp.in` - this is template for generating
+ `catch_user_config.hpp` which contains the materialized configuration
+ * other files as needed, e.g. `catch2/internal/catch_config_foo.hpp`
+ for the logic that guards the configuration
+
+
## CoC
This project has a [CoC](../CODE_OF_CONDUCT.md). Please adhere to it