Commit 32526908 authored by Alan Maguire's avatar Alan Maguire Committed by Shuah Khan
Browse files

kunit: update documentation to describe debugfs representation 



Documentation should describe debugfs layout and semantics.

Signed-off-by: default avatarAlan Maguire <alan.maguire@oracle.com>
Reviewed-by: default avatarBrendan Higgins <brendanhiggins@google.com>
Reviewed-by: default avatarFrank Rowand <frank.rowand@sony.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent c3bba690

Documentation/dev-tools/kunit/usage.rst

+14 −0
Original line number Diff line number Diff line
@@ -591,3 +591,17 @@ able to run one test case per invocation. 


.. TODO(brendanhiggins@google.com): Add an actual example of an architecture

   dependent KUnit test.



KUnit debugfs representation

============================

When kunit test suites are initialized, they create an associated directory

in /sys/kernel/debug/kunit/<test-suite>.  The directory contains one file



- results: "cat results" displays results of each test case and the results

  of the entire suite for the last test run.



The debugfs representation is primarily of use when kunit test suites are

run in a native environment, either as modules or builtin.  Having a way

to display results like this is valuable as otherwise results can be

intermixed with other events in dmesg output.  The maximum size of each

results file is KUNIT_LOG_SIZE bytes (defined in include/kunit/test.h).

CRA Git | Maintained and supported by SUSTech CRA and CCSE