Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

Document adding new CATCH_CONFIG options to contributing.md

Commit
066cc51ce657a3d787ec228e8af22830a92723fc
Author
Martin Hořeňovský ·
Parents
b7f4a2efb808

Files · Download .tar.gz

Changes

 docs/contributing.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

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