summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2024-04-24 18:29:01 +0300
committerGitHub <noreply@github.com>2024-04-24 18:29:01 +0300
commit575414094d5af092cb0c0809cb60549f400b57a9 (patch)
tree638d266534b4ac0db79e4ccfa66dda102f6cfde8 /docs
parent44c279a92063ad01ad26ef47b126fe180bc0947b (diff)
parentd68306c9c8641bfd200d77cd1afa0d032648c365 (diff)
downloadmeson-575414094d5af092cb0c0809cb60549f400b57a9.tar.gz
Merge pull request #13112 from DaanDeMeyer/interactive
Add meson test --interactive
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Unit-tests.md10
-rw-r--r--docs/markdown/snippets/test_interactive.md6
2 files changed, 16 insertions, 0 deletions
diff --git a/docs/markdown/Unit-tests.md b/docs/markdown/Unit-tests.md
index dc509a818..73e58dc68 100644
--- a/docs/markdown/Unit-tests.md
+++ b/docs/markdown/Unit-tests.md
@@ -256,6 +256,16 @@ $ meson test --gdb --gdb-path /path/to/gdb testname
$ meson test --print-errorlogs
```
+Running tests interactively can be done with the `--interactive` option.
+`meson test --interactive` invokes tests with stdout, stdin and stderr
+connected directly to the calling terminal. This can be useful if your test is
+an integration test running in a container or virtual machine where a debug
+shell is spawned if it fails *(added 1.5.0)*:
+
+```console
+$ meson test --interactive testname
+```
+
Meson will report the output produced by the failing tests along with
other useful information as the environmental variables. This is
useful, for example, when you run the tests on Travis-CI, Jenkins and
diff --git a/docs/markdown/snippets/test_interactive.md b/docs/markdown/snippets/test_interactive.md
new file mode 100644
index 000000000..907147fd9
--- /dev/null
+++ b/docs/markdown/snippets/test_interactive.md
@@ -0,0 +1,6 @@
+## The Meson test program supports a new "--interactive" argument
+
+`meson test --interactive` invokes tests with stdout, stdin and stderr
+connected directly to the calling terminal. This can be useful when running
+integration tests that run in containers or virtual machines which can spawn a
+debug shell if a test fails.