Thread (7 messages) 7 messages, 2 authors, 2020-03-02

Re: [PATCH v5 kunit-next 4/4] kunit: update documentation to describe debugfs representation

From: Frank Rowand <hidden>
Date: 2020-03-02 19:53:21
Also in: linux-kselftest, lkml

On 2/19/20 10:17 AM, Alan Maguire wrote:
quoted hunk ↗ jump to hunk
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.
Given my corrected understanding of kunit_log():

  +The maximum size of each 'results' file is KUNIT_LOG_SIZE bytes.

Am I understanding this correctly?

-Frank
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help