mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-28 23:23:55 +08:00
c797997a24
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>
43 lines
787 B
ReStructuredText
43 lines
787 B
ReStructuredText
================================
|
|
Development tools for the kernel
|
|
================================
|
|
|
|
This document is a collection of documents about development tools that can
|
|
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
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
testing-overview
|
|
checkpatch
|
|
coccinelle
|
|
sparse
|
|
kcov
|
|
gcov
|
|
kasan
|
|
ubsan
|
|
kmemleak
|
|
kcsan
|
|
kfence
|
|
gdb-kernel-debugging
|
|
kgdb
|
|
kselftest
|
|
kunit/index
|
|
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|