From ec02753fbf9c15389f953d9cfd040635f84779d9 Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Wed, 20 Jan 2021 15:16:01 +0100 Subject: [PATCH] docs: add documentation snippet for meson test console output changes --- docs/markdown/snippets/meson_test_logs.md | 29 +++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/markdown/snippets/meson_test_logs.md diff --git a/docs/markdown/snippets/meson_test_logs.md b/docs/markdown/snippets/meson_test_logs.md new file mode 100644 index 000000000..b3f5a16e1 --- /dev/null +++ b/docs/markdown/snippets/meson_test_logs.md @@ -0,0 +1,29 @@ +## New logging format for `meson test` + +The console output format for `meson test` has changed in several ways. +The major changes are: + +* if stdout is a tty, `meson` includes a progress report. + +* if `--print-errorlogs` is specified, the logs are printed as test runs +rather than afterwards. All the error logs are printed rather than only +the first ten. + +* if `--verbose` is specified and `--num-processes` specifies more than +one concurrent test, test output is buffered and printed after the +test finishes + +* the console logs include a reproducer command. If `--verbose` is +specified, the command is printed for all tests at the time they starts; +otherwise, it is printed for failing tests at the time the test finishes + +* for TAP tests, Meson is able to report individual subtests. If +`--verbose` is specified, all tests are reported. If `--print-errorlogs` +is specified, only failures are. + +In addition, if `--verbose` was specified, Meson used not to generate +logs. This limitation has now been removed. + +These changes make the default `ninja test` output more readable, while +`--verbose` output is provides detailed but human-readable logs that +are well suited to CI environments.