Documentation: KUnit: add intro to the getting-started page
authorTales Aparecida <tales.aparecida@gmail.com>
Mon, 22 Aug 2022 02:26:43 +0000 (23:26 -0300)
committerShuah Khan <skhan@linuxfoundation.org>
Fri, 30 Sep 2022 19:21:02 +0000 (13:21 -0600)
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>
Documentation/dev-tools/kunit/start.rst

index adf7825..75fd052 100644 (file)
@@ -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