diff options
author | Tales Aparecida <tales.aparecida@gmail.com> | 2022-08-22 04:26:43 +0200 |
---|---|---|
committer | Shuah Khan <skhan@linuxfoundation.org> | 2022-09-30 21:21:02 +0200 |
commit | deff8d2955aa045d7053a7770cdae9874af6f474 (patch) | |
tree | d0853433479c7e126dc537d2b6da6089bfd59ea1 | |
parent | Documentation: KUnit: Reword start guide for selecting tests (diff) | |
download | linux-deff8d2955aa045d7053a7770cdae9874af6f474.tar.xz linux-deff8d2955aa045d7053a7770cdae9874af6f474.zip |
Documentation: KUnit: add intro to the getting-started page
Describe the objective of the Getting Started page, which should be a
brief and beginner-friendly walkthrough for running and writing tests,
showing the reader where to find detailed instructions in other pages.
Signed-off-by: Tales Aparecida <tales.aparecida@gmail.com>
Reviewed-by: MaĆra Canal <mairacanal@riseup.net>
Reviewed-by:Sadiya Kazi<Sadiaykazi@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
-rw-r--r-- | Documentation/dev-tools/kunit/start.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst index adf782507999..75fd05286396 100644 --- a/Documentation/dev-tools/kunit/start.rst +++ b/Documentation/dev-tools/kunit/start.rst @@ -4,6 +4,10 @@ Getting Started =============== +This page contains an overview of the kunit_tool and KUnit framework, +teaching how to run existing tests and then how to write a simple test case, +and covers common problems users face when using KUnit for the first time. + Installing Dependencies ======================= KUnit has the same dependencies as the Linux kernel. As long as you can |