From: Brendan Higgins <brendanhiggins@google.com>
To: Alan Maguire <alan.maguire@oracle.com>
Cc: Greg KH <gregkh@linuxfoundation.org>,
Jonathan Corbet <corbet@lwn.net>,
"open list:KERNEL SELFTEST FRAMEWORK"
<linux-kselftest@vger.kernel.org>,
KUnit Development <kunit-dev@googlegroups.com>,
"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v2 kunit-next 3/3] kunit: update documentation to describe debugfs representation
Date: Thu, 30 Jan 2020 18:51:56 -0800 [thread overview]
Message-ID: <CAFd5g47sbW25MeOs87NuP_kRMNQc0JfiVVDTcLCbNk06KNo-ww@mail.gmail.com> (raw)
In-Reply-To: <1579805221-31905-4-git-send-email-alan.maguire@oracle.com>
On Thu, Jan 23, 2020 at 10:47 AM Alan Maguire <alan.maguire@oracle.com> wrote:
>
> Documentation should describe debugfs layout and semantics.
>
> Signed-off-by: Alan Maguire <alan.maguire@oracle.com>
> ---
> Documentation/dev-tools/kunit/usage.rst | 19 +++++++++++++++++++
> 1 file changed, 19 insertions(+)
>
> diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
> index 7cd56a1..b05c843 100644
> --- a/Documentation/dev-tools/kunit/usage.rst
> +++ b/Documentation/dev-tools/kunit/usage.rst
> @@ -590,3 +590,22 @@ 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 two files
> +
> +- results: "cat results" displays results of last test run
> +- run: "cat run" runs the test suite and displays the results
> +
> +Thus to re-run all currently loaded suites and display results, we can do this:
> +
> +```
> +$ cat /sys/kernel/debug/kunit/*/run
> +```
This should be in a ".. code-block:: bash", see above in this file for
an example.
> +
> +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-01-31 2:52 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-23 18:46 [PATCH v2 kunit-next 0/3] kunit: add debugfs representation to show results/run tests Alan Maguire
2020-01-23 18:46 ` [PATCH v2 kunit-next 1/3] kunit: add debugfs /sys/kernel/debug/kunit/<suite>/results display Alan Maguire
2020-01-31 2:23 ` Brendan Higgins
2020-01-23 18:47 ` [PATCH v2 kunit-next 2/3] kunit: add "run" debugfs file to run suites, display results Alan Maguire
2020-01-31 2:43 ` Brendan Higgins
2020-01-23 18:47 ` [PATCH v2 kunit-next 3/3] kunit: update documentation to describe debugfs representation Alan Maguire
2020-01-31 2:51 ` Brendan Higgins [this message]
2020-01-23 22:24 ` [PATCH v2 kunit-next 0/3] kunit: add debugfs representation to show results/run tests Brendan Higgins
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=CAFd5g47sbW25MeOs87NuP_kRMNQc0JfiVVDTcLCbNk06KNo-ww@mail.gmail.com \
--to=brendanhiggins@google.com \
--cc=alan.maguire@oracle.com \
--cc=corbet@lwn.net \
--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 \
/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).