From: Alan Maguire <alan.maguire@oracle.com>
To: brendanhiggins@google.com, frowand.list@gmail.com,
gregkh@linuxfoundation.org, shuah@kernel.org
Cc: corbet@lwn.net, linux-kselftest@vger.kernel.org,
linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com,
linux-doc@vger.kernel.org, Alan Maguire <alan.maguire@oracle.com>
Subject: [PATCH v5 kunit-next 4/4] kunit: update documentation to describe debugfs representation
Date: Wed, 19 Feb 2020 16:17:10 +0000 [thread overview]
Message-ID: <1582129030-22282-5-git-send-email-alan.maguire@oracle.com> (raw)
In-Reply-To: <1582129030-22282-1-git-send-email-alan.maguire@oracle.com>
Documentation should describe debugfs layout and semantics.
Signed-off-by: Alan Maguire <alan.maguire@oracle.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
---
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
next prev parent reply other threads:[~2020-02-19 16:17 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-19 16:17 [PATCH v5 kunit-next 0/4] kunit: add debugfs representation to show results Alan Maguire
2020-02-19 16:17 ` [PATCH v5 kunit-next 1/4] kunit: add debugfs /sys/kernel/debug/kunit/<suite>/results display Alan Maguire
2020-03-02 19:53 ` Frank Rowand
2020-02-19 16:17 ` [PATCH v5 kunit-next 2/4] kunit: add log test Alan Maguire
2020-02-19 16:17 ` [PATCH v5 kunit-next 3/4] kunit: subtests should be indented 4 spaces according to TAP Alan Maguire
2020-02-19 16:17 ` Alan Maguire [this message]
2020-03-02 19:53 ` [PATCH v5 kunit-next 4/4] kunit: update documentation to describe debugfs representation Frank Rowand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1582129030-22282-5-git-send-email-alan.maguire@oracle.com \
--to=alan.maguire@oracle.com \
--cc=brendanhiggins@google.com \
--cc=corbet@lwn.net \
--cc=frowand.list@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=kunit-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=shuah@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.