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

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorLukasz Okraszewski2022-04-08 17:01:59 +0100
committerGitHub2022-04-08 18:01:59 +0200
commitcb551b4f6d338020322eb39a2f3747c81896a1ba (patch)
treec44d70ec3a0f007fe2cada04b72100b73d67a368 /docs
parent4b7815798107b4226b5e00b6f49e4be5848328e6 (diff)
downloadcatch3-cb551b4f6d338020322eb39a2f3747c81896a1ba.tar.gz
Add default reporter for Bazel integration (#2399)
When the added Bazel configuration flag is enabled, a default JUnit reporter will be added if the XML envrioment variable is defined. Fix include paths for generated config header. Enable Bazel config by default when building with Bazel. Co-authored-by: Martin Hořeňovský <martin.horenovsky@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 5105f6d9..dc7178c7 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -8,6 +8,7 @@
[stdout](#stdout)<br>
[Fallback stringifier](#fallback-stringifier)<br>
[Default reporter](#default-reporter)<br>
+[Bazel support](#bazel-support)<br>
[C++11 toggles](#c11-toggles)<br>
[C++17 toggles](#c17-toggles)<br>
[Other toggles](#other-toggles)<br>
@@ -96,6 +97,12 @@ This means that defining `CATCH_CONFIG_DEFAULT_REPORTER` to `"console"`
is equivalent with the out-of-the-box experience.
+## Bazel support
+When `CATCH_CONFIG_BAZEL_SUPPORT` is defined, Catch2 will register a `JUnit`
+reporter writing to a path pointed by `XML_OUTPUT_FILE` provided by Bazel.
+
+> `CATCH_CONFIG_BAZEL_SUPPORT` was [introduced](https://github.com/catchorg/Catch2/pull/2399) in Catch2 X.Y.Z.
+
## C++11 toggles
CATCH_CONFIG_CPP11_TO_STRING // Use `std::to_string`