Skip to content

Commit 802c663

Browse files
committed
Define "failure" in "Test Status Results"
1 parent 2a6e543 commit 802c663

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

llvm/docs/CommandGuide/lit.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ EXECUTION OPTIONS
193193

194194
.. option:: --report-failures-only
195195

196-
Only include unresolved, timed out, failed and unexpectedly passed tests in the report.
196+
Only include failures (see :ref:`test-status-results`) in the report.
197197

198198
.. option:: --resultdb-output RESULTDB_OUTPUT
199199

@@ -384,9 +384,8 @@ ADDITIONAL OPTIONS
384384
EXIT STATUS
385385
-----------
386386

387-
:program:`lit` will exit with an exit code of 1 if there are any failures (i.e.
388-
unresolved, timed out, failed or unexpectedly passed tests, see also
389-
:option:`--report-failures-only`) and :option:`--ignore-fail` has not been
387+
:program:`lit` will exit with an exit code of 1 if there are any failures
388+
(see :ref:`test-status-results`) and :option:`--ignore-fail` has not been
390389
passed. Otherwise, it will exit with the status 0. Other exit codes are used
391390
for non-test related failures (for example a user error or an internal program
392391
error).
@@ -463,8 +462,10 @@ Each test ultimately produces one of the following eight results:
463462

464463
**TIMEOUT**
465464

466-
The test was run, but it timed out before it was able to complete. This is
467-
considered a failure.
465+
The test was run, but it timed out before it was able to complete.
466+
467+
Unresolved (**UNRESOLVED**), timed out (**TIMEOUT**), failed (**FAIL**) and
468+
unexpectedly passed (**XPASS**) tests are considered failures.
468469

469470
Depending on the test format tests may produce additional information about
470471
their status (generally only for failures). See the :ref:`output-options`

0 commit comments

Comments
 (0)