[PATCH v5 kunit-next 4/4] kunit: update documentation to describe debugfs representation
From: Alan Maguire <hidden>
Date: 2020-02-19 16:17:59
Also in:
linux-kselftest, lkml
Subsystem:
documentation, documentation process, kernel unit testing framework (kunit), the rest · Maintainers:
Jonathan Corbet, Brendan Higgins, David Gow, Linus Torvalds
Documentation should describe debugfs layout and semantics. Signed-off-by: Alan Maguire <redacted> Reviewed-by: Brendan Higgins <redacted> --- Documentation/dev-tools/kunit/usage.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+)
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 607758a..14b0236 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst@@ -591,3 +591,16 @@ 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.
--
1.8.3.1