linux-stable/Documentation/dev-tools
David Gow c797997a24 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>
2021-04-15 14:53:02 -06:00
..
kunit Documentation: kunit: add tips.rst for small examples 2021-02-08 15:41:11 -07:00
checkpatch.rst docs: document all error message types in checkpatch 2021-03-25 11:47:42 -06:00
coccinelle.rst Documentation: Coccinelle: Improve command example for debugging patches 2020-12-03 15:45:18 -07:00
gcov.rst docs/gcov: Convert two tags to ref in dev-tools/gov.rst 2021-04-08 11:19:43 -06:00
gdb-kernel-debugging.rst Replace HTTP links with HTTPS ones: documentation 2020-06-08 09:30:19 -06:00
index.rst Documentation: dev-tools: Add Testing Overview 2021-04-15 14:53:02 -06:00
kasan.rst kasan: clarify that only first bug is reported in HW_TAGS 2021-02-26 09:41:03 -08:00
kcov.rst Documentation: fix typos found in process, dev-tools, and doc-guide subdirectories 2020-12-03 15:55:04 -07:00
kcsan.rst kcsan: Re-add GCC as a supported compiler 2020-06-29 12:04:48 -07:00
kfence.rst kfence: report sensitive information based on no_hash_pointers 2021-02-26 09:41:02 -08:00
kgdb.rst Documentation: kgdb: Fix a typo 2020-11-18 13:47:17 -07:00
kmemleak.rst mm,kmemleak-test.c: move kmemleak-test.c to samples dir 2020-10-13 18:38:27 -07:00
kselftest.rst doc: dev-tools: kselftest.rst: Update examples and paths 2020-10-07 07:59:24 -06:00
sparse.rst doc: add link to sparse's home page/internal docs 2020-07-05 14:32:56 -06:00
testing-overview.rst Documentation: dev-tools: Add Testing Overview 2021-04-15 14:53:02 -06:00
ubsan.rst ubsan: remove UBSAN_MISC in favor of individual options 2020-12-15 22:46:19 -08:00