Merge pull request #5289 from mesonbuild/fixxpass

Report xpass results as failures.

1 files changed, 15 insertions, 0 deletions

diff --git a/docs/markdown/snippets/xfail.md b/docs/markdown/snippets/xfail.md
new file mode 100644
index 0000000..5392fa9
--- /dev/null
+++ b/docs/markdown/snippets/xfail.md
@@ -0,0 +1,15 @@
+## Tests that should fail but did not are now errors
+
+You can tag a test as needing to fail like this:
+
+```meson
+test('shoulfail', exe, should_fail: true)
+```
+
+If the test passes the problem is reported in the error logs but due
+to a bug it was not reported in the test runner's exit code. Starting
+from this release the unexpected passes are properly reported in the
+test runner's exit code. This means that test runs that were passing
+in earlier versions of Meson will report failures with the current
+version. This is a good thing, though, since it reveals an error in
+your test suite that has, until now, gone unnoticed.