Skip to content

Commit eba9c44

Browse files
Ingo Molnarpaulmckrcu
authored andcommitted
Improve KCSAN documentation a bit
This commit simplifies and clarifies the highest level KCSAN Kconfig help text. Signed-off-by: Ingo Molnar <[email protected]> Signed-off-by: Paul E. McKenney <[email protected]>
1 parent cdb9b07 commit eba9c44

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

lib/Kconfig.kcsan

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@ config HAVE_ARCH_KCSAN
44
bool
55

66
menuconfig KCSAN
7-
bool "KCSAN: dynamic race detector"
7+
bool "KCSAN: dynamic data race detector"
88
depends on HAVE_ARCH_KCSAN && DEBUG_KERNEL && !KASAN
99
select STACKTRACE
1010
help
11-
The Kernel Concurrency Sanitizer (KCSAN) is a dynamic race detector,
12-
which relies on compile-time instrumentation, and uses a
13-
watchpoint-based sampling approach to detect races.
11+
The Kernel Concurrency Sanitizer (KCSAN) is a dynamic
12+
data-race detector that relies on compile-time instrumentation.
13+
KCSAN uses a watchpoint-based sampling approach to detect races.
1414

15-
KCSAN's primary purpose is to detect data races. KCSAN can also be
16-
used to check properties, with the help of provided assertions, of
17-
concurrent code where bugs do not manifest as data races.
15+
While KCSAN's primary purpose is to detect data races, it
16+
also provides assertions to check data access constraints.
17+
These assertions can expose bugs that do not manifest as
18+
data races.
1819

1920
See <file:Documentation/dev-tools/kcsan.rst> for more details.
2021

0 commit comments

Comments
 (0)