Commit Graph
5 Commits
Author SHA1 Message Date
Brendan Jackman 42fb9cfd5b Documentation: dev-tools: Add link to RV docs
I could not remember the name of this system and it's pretty hard to
find without the right keywords. I had to ask an LLM!

Drop a breadcrumb to help people find it in the future.

Signed-off-by: Brendan Jackman <[email protected]>
Acked-by: Daniel Bristot de Oliveira <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
2024-03-29 08:27:21 -06:00
Marcelo Schmitt a32d5c0fc1 Documentation: dev-tools: Enhance static analysis section with discussion
Enhance the static analysis tools section with a discussion on when to
use each of them.

This was mainly taken from Dan Carpenter and Julia Lawall's comments on
a previous documentation patch for static analysis tools.

Lore: https://lore.kernel.org/linux-doc/20220329090911.GX3293@kadam/T/#mb97770c8e938095aadc3ee08f4ac7fe32ae386e6

Signed-off-by: Marcelo Schmitt <[email protected]>
Acked-by: David Gow <[email protected]>
Cc: Dan Carpenter <[email protected]>
Cc: Julia Lawall <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
2022-04-05 09:48:25 -06:00
Marcelo Schmitt 12379401c0 Documentation: dev-tools: Add a section for static analysis tools
Complement the Kernel Testing Guide documentation page by adding a
section about static analysis tools.

Signed-off-by: Marcelo Schmitt <[email protected]>
Acked-by: Daniel Latypov <[email protected]>
Acked-by: Dan Carpenter <[email protected]>
Acked-by: Julia Lawall <[email protected]>
Reviewed-by: David Gow <[email protected]>
Reviewed-by: Shuah Khan <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
2022-04-05 09:48:24 -06:00
Mauro Carvalho Chehab 3a8b57d27a docs: dev-tools: testing-overview.rst: avoid using ReST :doc:foo markup
The :doc:`foo` tag is auto-generated via automarkup.py.
So, use the filename at the sources, instead of :doc:`foo`.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
Link: https://lore.kernel.org/r/6bbecd4170ee08f36f8060b0719a46c64a21aefc.1623824363.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <[email protected]>
2021-06-17 13:24:37 -06:00
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 <[email protected]>
Reviewed-by: Marco Elver <[email protected]>
Reviewed-by: Daniel Latypov <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>
2021-04-15 14:53:02 -06:00