3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2025-11-04 05:59:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document magic %-prefixed streams

Browse Source
This commit is contained in:
Martin Hořeňovský
2022-04-07 12:40:46 +02:00
parent f9f4e58dfb
commit 46b3f7ee5f
2 changed files with 26 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/command-line.md
View File

@@ -218,12 +218,24 @@ similar information.
<pre>-o, --out &lt;filename&gt;
</pre>
Use this option to send all output to a file. By default output is sent to stdout (note that uses of stdout and stderr *from within test cases* are redirected and included in the report - so even stderr will effectively end up on stdout).
Using `-` as the filename sends the output to stdout.
Use this option to send all output to a file, instead of stdout. You can
use `-` as the filename to explicitly send the output to stdout (this is
useful e.g. when using multiple reporters).
> Support for `-` as the filename was introduced in Catch2 X.Y.Z
Filenames starting with "%" (percent symbol) are reserved by Catch2 for
meta purposes, e.g. using `%debug` as the filename opens stream that
writes to platform specific debugging/logging mechanism.
Catch2 currently recognizes 3 meta streams:
* `%debug` - writes to platform specific debugging/logging output
* `%stdout` - writes to stdout
* `%stderr` - writes to stderr
> Support for `%stdout` and `%stderr` was introduced in Catch2 X.Y.Z
<a id="naming-a-test-run"></a>
## Naming a test run