diff --git a/selftest/README b/selftest/README index f8be20a569c..3fe6af5362a 100644 --- a/selftest/README +++ b/selftest/README @@ -11,7 +11,7 @@ the name of the test, the command to run and the environment that should be provided. Use the included "plantest" function to generate the required output. Testsuite behaviour -================================ +=================== Exit code ------------ @@ -31,27 +31,35 @@ for the last announced test. Accepted commands are: test -~~~~~~~~~~~~ +~~~~ test: Announce that a new test with the specified name is starting success -~~~~~~~~~~~~~~~ +~~~~~~~ success: Announce that the test with the specified name is done and ran successfully. failure -~~~~~~~~~~~~~~~ +~~~~~~~ failure: failure: [ REASON ] Announce that the test with the specified name failed. Optionally, it is possible to specify a reason it failed. +xfail +~~~~~ +xfail: +xfail: [ REASON ] + +Announce that the test with the specified name failed but that the failure +was expected, e.g. it's a test for a known bug that hasn't been fixed yet. + skip -~~~~~~~~~~~~ +~~~~ skip: skip: [ REASON ]