linux-kernel - [PATCH v8 kunit-next 4/4] kunit: update documentation to describe debugfs representation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1585232710-322-5-git-send-email-alan.maguire@oracle.com>
Date:   Thu, 26 Mar 2020 14:25:10 +0000
From:   Alan Maguire <alan.maguire@...cle.com>
To:     brendanhiggins@...gle.com, frowand.list@...il.com,
        gregkh@...uxfoundation.org, shuah@...nel.org,
        linux-kselftest@...r.kernel.org
Cc:     corbet@....net, linux-kernel@...r.kernel.org,
        kunit-dev@...glegroups.com, linux-doc@...r.kernel.org
Subject: [PATCH v8 kunit-next 4/4] kunit: update documentation to describe debugfs representation

Documentation should describe debugfs layout and semantics.

Signed-off-by: Alan Maguire <alan.maguire@...cle.com>
Reviewed-by: Brendan Higgins <brendanhiggins@...gle.com>
Reviewed-by: Frank Rowand <frank.rowand@...y.com>
---
 Documentation/dev-tools/kunit/usage.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 607758a..473a236 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@...gle.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).
-- 
1.8.3.1