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 --- Documentation/dev-tools/kunit/start.rst | 5 +++++ 1 file changed, 5 insertions(+)
diff --git a/Documentation/dev-tools/kunit/start.rst b/Documentation/dev-tools/kunit/start.rst index f0ec64207bd3..3855402a5b3e 100644 --- a/Documentation/dev-tools/kunit/start.rst +++ b/Documentation/dev-tools/kunit/start.rst @@ -4,6 +4,11 @@ Getting Started ===============
+This page contains an overview about the kunit_tool and Kunit framework, +teaching how to run existent tests and then how to write a simple test-case, +and covering common problems users face when using Kunit for the first time. +It is recommended that the reader had compiled the Kernel at least once before. + Installing Dependencies ======================= KUnit has the same dependencies as the Linux kernel. As long as you can