| Message ID | 1582129030-22282-5-git-send-email-alan.maguire@oracle.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | kunit: add debugfs representation to show results | expand |
On 2/19/20 10:17 AM, Alan Maguire wrote: > 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. > 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
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.