From: Alan Maguire <alan.maguire@oracle.com>
To: skhan@linuxfoundation.org, brendanhiggins@google.com,
frowand.list@gmail.com
Cc: gregkh@linuxfoundation.org, linux-kselftest@vger.kernel.org,
linux-kernel@vger.kernel.org, kunit-dev@googlegroups.com,
corbet@lwn.net, linux-doc@vger.kernel.org,
Alan Maguire <alan.maguire@oracle.com>
Subject: [PATCH v4 kunit-next 3/3] kunit: update documentation to describe debugfs representation
Date: Mon, 17 Feb 2020 14:27:40 +0000 [thread overview]
Message-ID: <1581949660-20113-4-git-send-email-alan.maguire@oracle.com> (raw)
In-Reply-To: <1581949660-20113-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 7cd56a1..816fff4 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -590,3 +590,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
prev parent reply other threads:[~2020-02-17 14:28 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-17 14:27 [PATCH v4 kunit-next 0/3] kunit: add debugfs representation to show results Alan Maguire
2020-02-17 14:27 ` [PATCH v4 kunit-next 1/3] kunit: add debugfs /sys/kernel/debug/kunit/<suite>/results display Alan Maguire
2020-02-17 14:27 ` [PATCH v4 kunit-next 2/3] kunit: add log test Alan Maguire
2020-02-18 19:26 ` Brendan Higgins
2020-02-17 14:27 ` Alan Maguire [this message]
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=1581949660-20113-4-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=skhan@linuxfoundation.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).