Documentation should describe debugfs layout and semantics.
Signed-off-by: Alan Maguire <[email protected]>
---
Documentation/dev-tools/kunit/usage.rst | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 7cd56a1..b2b958a 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -590,3 +590,15 @@ able to run one test case per invocation.
.. TODO([email protected]): 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 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
On Fri, Feb 7, 2020 at 8:59 AM Alan Maguire <[email protected]> wrote:
>
> Documentation should describe debugfs layout and semantics.
>
> Signed-off-by: Alan Maguire <[email protected]>
Reviewed-by: Brendan Higgins <[email protected]>
Thanks!
On 2/7/20 10:58 AM, Alan Maguire wrote:
> Documentation should describe debugfs layout and semantics.
>
> Signed-off-by: Alan Maguire <[email protected]>
> ---
> Documentation/dev-tools/kunit/usage.rst | 12 ++++++++++++
> 1 file changed, 12 insertions(+)
>
> diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
> index 7cd56a1..b2b958a 100644
> --- a/Documentation/dev-tools/kunit/usage.rst
> +++ b/Documentation/dev-tools/kunit/usage.rst
> @@ -590,3 +590,15 @@ able to run one test case per invocation.
>
> .. TODO([email protected]): 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 last test run
s/last test run/each test case and the result 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.