summaryrefslogtreecommitdiffstats
path: root/Documentation/dev-tools/kcsan.rst
diff options
context:
space:
mode:
authorMarco Elver <elver@google.com>2021-06-07 14:56:49 +0200
committerPaul E. McKenney <paulmck@kernel.org>2021-07-20 22:49:43 +0200
commite675d2533a74acfa95c62e7bb088335866f44fd2 (patch)
tree576b958d47c0161ee9088d62ac476a5861a0e739 /Documentation/dev-tools/kcsan.rst
parentkcsan: Remove CONFIG_KCSAN_DEBUG (diff)
downloadlinux-e675d2533a74acfa95c62e7bb088335866f44fd2.tar.xz
linux-e675d2533a74acfa95c62e7bb088335866f44fd2.zip
kcsan: Introduce CONFIG_KCSAN_STRICT
Add a simpler Kconfig variable to configure KCSAN's "strict" mode. This makes it simpler in documentation or messages to suggest just a single configuration option to select the strictest checking mode (vs. currently having to list several options). Signed-off-by: Marco Elver <elver@google.com> Acked-by: Mark Rutland <mark.rutland@arm.com> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Diffstat (limited to 'Documentation/dev-tools/kcsan.rst')
-rw-r--r--Documentation/dev-tools/kcsan.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
index 6a600cf8430b..69dc9c502ccc 100644
--- a/Documentation/dev-tools/kcsan.rst
+++ b/Documentation/dev-tools/kcsan.rst
@@ -127,6 +127,10 @@ Kconfig options:
causes KCSAN to not report data races due to conflicts where the only plain
accesses are aligned writes up to word size.
+To use the strictest possible rules, select ``CONFIG_KCSAN_STRICT=y``, which
+configures KCSAN to follow the Linux-kernel memory consistency model (LKMM) as
+closely as possible.
+
DebugFS interface
~~~~~~~~~~~~~~~~~