diff options
| author | Leitwolf | 2026-10-29 12:18:33 +0300 |
|---|---|---|
| committer | GitHub | 2026-10-29 12:18:33 +0300 |
| commit | 1d48419b7ef642917ebf7dfd16c3bc1b3050d8f1 (patch) | |
| tree | 2e3327fb973f9560b5067d654f3a21ff12a821aa /docs | |
| parent | d2e3e074bb2e1b8ffd9fc990d0b87667ea602f58 (diff) | |
| parent | 30176b75937e87eafbb4f5557eb0be9697753ddf (diff) | |
| download | catch3-1d48419b7ef642917ebf7dfd16c3bc1b3050d8f1.tar.gz | |
Merge pull request #19 from Progmasoft/feature/yyjson-pugixml
Read and write JSON with yyjson and JUnit XML with pugixml
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/migrate-v2-to-v3.md | 7 | ||||
| -rw-r--r-- | docs/release-notes.md | 7 |
2 files changed, 11 insertions, 3 deletions
diff --git a/docs/migrate-v2-to-v3.md b/docs/migrate-v2-to-v3.md index 91f65ac8..bd030523 100644 --- a/docs/migrate-v2-to-v3.md +++ b/docs/migrate-v2-to-v3.md @@ -37,9 +37,10 @@ To migrate to v3, there are two basic approaches to do so. 1. Use `catch_amalgamated.hpp` and `catch_amalgamated.cpp`. 2. Build Catch3 as a proper (static) library, and move to piecewise headers -Doing 1 means downloading the [amalgamated header](../extras/catch_amalgamated.hpp) -and the [amalgamated sources](../extras/catch_amalgamated.cpp) from `extras`, -dropping them into your test project, and rewriting your includes from +Doing 1 means downloading the [amalgamated header](../extras/catch_amalgamated.hpp), +the [amalgamated sources](../extras/catch_amalgamated.cpp) and +[the JSON and XML libraries they include](../extras/catch_amalgamated_third_party.hpp) +from `extras`, dropping them into your test project, and rewriting your includes from `<catch2/catch.hpp>` to `"catch_amalgamated.hpp"` (or something similar, based on how you set up your paths). diff --git a/docs/release-notes.md b/docs/release-notes.md index 3dd4ca66..aef49cf0 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -33,6 +33,13 @@ line and reporters with [a runner of its own](progmasoft-runner.md#top): * Reports are console, JUnit XML, JSON and a Chrome trace; `--list=json` is a versioned discovery format. * Every test gets a temporary directory of its own. +* JSON is read and written with [yyjson](https://github.com/ibireme/yyjson) + and JUnit XML is written with [pugixml](https://github.com/zeux/pugixml), + both MIT and vendored in `third_party/`. They are compiled into Catch3's + own translation units with internal linkage or a renamed namespace, so a + project that links its own copy of either library is not affected. The + amalgamated sources include them from a third file, + `extras/catch_amalgamated_third_party.hpp`. ### Breaking changes |