Improve KCSAN documentation a bit

This commit simplifies and clarifies the highest level KCSAN Kconfig
help text.

Signed-off-by: Ingo Molnar <mingo@kernel.org>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
This commit is contained in:
Ingo Molnar 2020-04-13 11:03:05 +02:00 committed by Paul E. McKenney
parent cdb9b07d8c
commit eba9c444d3

View file

@ -4,17 +4,18 @@ config HAVE_ARCH_KCSAN
bool bool
menuconfig KCSAN menuconfig KCSAN
bool "KCSAN: dynamic race detector" bool "KCSAN: dynamic data race detector"
depends on HAVE_ARCH_KCSAN && DEBUG_KERNEL && !KASAN depends on HAVE_ARCH_KCSAN && DEBUG_KERNEL && !KASAN
select STACKTRACE select STACKTRACE
help help
The Kernel Concurrency Sanitizer (KCSAN) is a dynamic race detector, The Kernel Concurrency Sanitizer (KCSAN) is a dynamic
which relies on compile-time instrumentation, and uses a data-race detector that relies on compile-time instrumentation.
watchpoint-based sampling approach to detect races. KCSAN uses a watchpoint-based sampling approach to detect races.
KCSAN's primary purpose is to detect data races. KCSAN can also be While KCSAN's primary purpose is to detect data races, it
used to check properties, with the help of provided assertions, of also provides assertions to check data access constraints.
concurrent code where bugs do not manifest as data races. These assertions can expose bugs that do not manifest as
data races.
See <file:Documentation/dev-tools/kcsan.rst> for more details. See <file:Documentation/dev-tools/kcsan.rst> for more details.