Skip to content

Commit b00db6f

Browse files
Muhammad Usama Anjumshuahkh
authored andcommitted
selftests: Add information about TAP conformance in tests
Although "TAP" word is being used already in documentation, but it hasn't been defined in informative way for developers that how to write TAP conformant tests and what are the benefits. Write a short brief about it. Signed-off-by: Muhammad Usama Anjum <[email protected]> Signed-off-by: Shuah Khan <[email protected]>
1 parent 0d66ddb commit b00db6f

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

Documentation/dev-tools/kselftest.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,13 @@ In general, the rules for selftests are
228228
* Don't cause the top-level "make run_tests" to fail if your feature is
229229
unconfigured.
230230

231+
* The output of tests must conform to the TAP standard to ensure high
232+
testing quality and to capture failures/errors with specific details.
233+
The kselftest.h and kselftest_harness.h headers provide wrappers for
234+
outputting test results. These wrappers should be used for pass,
235+
fail, exit, and skip messages. CI systems can easily parse TAP output
236+
messages to detect test results.
237+
231238
Contributing new tests (details)
232239
================================
233240

0 commit comments

Comments
 (0)