summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorIngo Molnar <mingo@kernel.org>2020-04-13 11:03:05 +0200
committerPaul E. McKenney <paulmck@kernel.org>2020-04-27 11:10:02 -0700
commiteba9c444d34c9f10cbb463329c2c8e14f2adff25 (patch)
tree0088374670fe14fc1684da264136ab42dead7977 /lib
parentcdb9b07d8c78be63d72aba9a2686ff161ddd2099 (diff)
downloadlinux-eba9c444d34c9f10cbb463329c2c8e14f2adff25.tar.gz
linux-eba9c444d34c9f10cbb463329c2c8e14f2adff25.tar.bz2
linux-eba9c444d34c9f10cbb463329c2c8e14f2adff25.zip
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>
Diffstat (limited to 'lib')
-rw-r--r--lib/Kconfig.kcsan15
1 files changed, 8 insertions, 7 deletions
diff --git a/lib/Kconfig.kcsan b/lib/Kconfig.kcsan
index 0f1447ff8f55..689b6b81f272 100644
--- a/lib/Kconfig.kcsan
+++ b/lib/Kconfig.kcsan
@@ -4,17 +4,18 @@ config HAVE_ARCH_KCSAN
bool
menuconfig KCSAN
- bool "KCSAN: dynamic race detector"
+ bool "KCSAN: dynamic data race detector"
depends on HAVE_ARCH_KCSAN && DEBUG_KERNEL && !KASAN
select STACKTRACE
help
- The Kernel Concurrency Sanitizer (KCSAN) is a dynamic race detector,
- which relies on compile-time instrumentation, and uses a
- watchpoint-based sampling approach to detect races.
+ The Kernel Concurrency Sanitizer (KCSAN) is a dynamic
+ data-race detector that relies on compile-time instrumentation.
+ KCSAN uses a watchpoint-based sampling approach to detect races.
- KCSAN's primary purpose is to detect data races. KCSAN can also be
- used to check properties, with the help of provided assertions, of
- concurrent code where bugs do not manifest as data races.
+ While KCSAN's primary purpose is to detect data races, it
+ also provides assertions to check data access constraints.
+ These assertions can expose bugs that do not manifest as
+ data races.
See <file:Documentation/dev-tools/kcsan.rst> for more details.