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@xxxxxxxxx>
Reviewed-by: Maíra Canal <mairacanal@xxxxxxxxxx>
---
Notes:
Remove recommendation about having compiled the kernel before using
kunit_tool. I changed my mind about it after Tim Bird's highlight.
---
Documentation/dev-tools/kunit/start.rst | 4 ++++
1 file changed, 4 insertions(+)
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
--
2.37.2
