diff options
author | David Gow <davidgow@google.com> | 2021-04-15 07:40:36 +0200 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2021-04-15 22:53:02 +0200 |
commit | c797997a244cd2c58908093509a24711fc67d146 (patch) | |
tree | 28afba120f2da442c3162def50ebbc775bb87ee6 /Documentation/dev-tools/index.rst | |
parent | docs/zh_CN: add translations in zh_CN/dev-tools/gcov (diff) | |
download | linux-c797997a244cd2c58908093509a24711fc67d146.tar.xz linux-c797997a244cd2c58908093509a24711fc67d146.zip |
Documentation: dev-tools: Add Testing Overview
The kernel now has a number of testing and debugging tools, and we've
seen a bit of confusion about what the differences between them are.
Add a basic documentation outlining the testing tools, when to use each,
and how they interact.
This is a pretty quick overview rather than the idealised "kernel
testing guide" that'd probably be optimal, but given the number of times
questions like "When do you use KUnit and when do you use Kselftest?"
are being asked, it seemed worth at least having something. Hopefully
this can form the basis for more detailed documentation later.
Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Marco Elver <elver@google.com>
Reviewed-by: Daniel Latypov <dlatypov@google.com>
Link: https://lore.kernel.org/r/20210415054036.581117-1-davidgow@google.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/dev-tools/index.rst')
-rw-r--r-- | Documentation/dev-tools/index.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst index 43d28998118b..010a2af1e7d9 100644 --- a/Documentation/dev-tools/index.rst +++ b/Documentation/dev-tools/index.rst @@ -7,6 +7,9 @@ be used to work on the kernel. For now, the documents have been pulled together without any significant effort to integrate them into a coherent whole; patches welcome! +A brief overview of testing-specific tools can be found in +Documentation/dev-tools/testing-overview.rst + .. class:: toc-title Table of contents @@ -14,6 +17,7 @@ whole; patches welcome! .. toctree:: :maxdepth: 2 + testing-overview checkpatch coccinelle sparse |