path: root/Documentation/dev-tools/kunit/usage.rst
diff options
authorAlan Maguire <alan.maguire@oracle.com>2020-03-26 14:25:10 +0000
committerShuah Khan <skhan@linuxfoundation.org>2020-03-26 14:09:16 -0600
commit32526908fe86dce55eb1af184335bdb863578eb2 (patch)
treee188767783bad33d7a8b3ed2d834735fe22f1749 /Documentation/dev-tools/kunit/usage.rst
parentkunit: subtests should be indented 4 spaces according to TAP (diff)
kunit: update documentation to describe debugfs representation
Documentation should describe debugfs layout and semantics. Signed-off-by: Alan Maguire <alan.maguire@oracle.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Reviewed-by: Frank Rowand <frank.rowand@sony.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Diffstat (limited to 'Documentation/dev-tools/kunit/usage.rst')
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 607758a66a99..473a2361ec37 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -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).