diff options
| author | Martin Hořeňovský | 2026-08-01 16:52:08 +0200 |
|---|---|---|
| committer | Martin Hořeňovský | 2026-08-07 20:57:42 +0200 |
| commit | a0eba50e9d56c743aff1de7a50d02a6e01e73cdc (patch) | |
| tree | fd87a006c59acd9295ec3c2856e29ee6d31ba30e /docs | |
| parent | 8b08d4d79514f45f7e4ce2a607ac9c94e920d1bb (diff) | |
| download | catch3-a0eba50e9d56c743aff1de7a50d02a6e01e73cdc.tar.gz | |
Make verbosity per-reporter
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/command-line.md | 9 | ||||
| -rw-r--r-- | docs/reporters.md | 8 |
2 files changed, 11 insertions, 6 deletions
diff --git a/docs/command-line.md b/docs/command-line.md index 7df8ecf6..cbb3449e 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -202,8 +202,13 @@ as many times as you want, e.g. `--reporter xml::out=someFile.xml` or The keys must either be prefixed by "X", in which case they are not parsed by Catch2 and are only passed down to the reporter, or one of options -hardcoded into Catch2. Currently there are only 2, -["out"](#sending-output-to-a-file), and ["colour-mode"](#colour-mode). +hardcoded into Catch2. Currently there are 3 supported options: + +* ["out"](#sending-output-to-a-file) +* ["colour-mode"](#colour-mode) +* ["verbosity"](#output-verbosity) + +> Support for per-reporter verbosity option was added in Catch2 vX.Y.Z _Note that the reporter might still check the X-prefixed options for validity, and throw an error if they are wrong._ diff --git a/docs/reporters.md b/docs/reporters.md index d42648cf..63297089 100644 --- a/docs/reporters.md +++ b/docs/reporters.md @@ -43,13 +43,13 @@ them write into different destinations. The two main uses of this are Specifying multiple reporter looks like this: ``` ---reporter JUnit::out=result-junit.xml --reporter console::out=-::colour-mode=ansi +--reporter JUnit::out=result-junit.xml --reporter console::out=-::colour-mode=ansi::verbosity=quiet ``` This tells Catch2 to use two reporters, `JUnit` reporter that writes its machine-readable XML output to file `result-junit.xml`, and the -`console` reporter that writes its user-friendly output to stdout and -uses ANSI colour codes for colouring the output. +`console` reporter that writes its user-friendly output to stdout, uses +ANSI colour codes for colouring the output and is set to "quiet" verbosity. Using multiple reporters (or one reporter and one-or-more [event listeners](event-listeners.md#top)) can have surprisingly complex semantics @@ -110,7 +110,7 @@ passing and failing assertions. _Generally we recommend that if you override a member function from either of the bases, you call into the base's implementation first. This is not -necessarily in all cases, but it is safer and easier._ +necessary in all cases, but it is safer and easier._ Writing your own reporter then looks like this: |