[tip: locking/kcsan] kcsan: Update Documentation to change supported compilers

From: tip-bot2 for Marco Elver
Date: Fri May 22 2020 - 12:09:20 EST


The following commit has been merged into the locking/kcsan branch of tip:

Commit-ID: 345043266de282a4059bc8336e2bcdd3680cc8f0
Gitweb: https://git.kernel.org/tip/345043266de282a4059bc8336e2bcdd3680cc8f0
Author: Marco Elver <elver@xxxxxxxxxx>
AuthorDate: Thu, 21 May 2020 16:20:43 +02:00
Committer: Borislav Petkov <bp@xxxxxxx>
CommitterDate: Fri, 22 May 2020 15:13:45 +02:00

kcsan: Update Documentation to change supported compilers

Document change in required compiler version for KCSAN, and remove the
now redundant note about __no_kcsan and inlining problems with older
compilers.

Signed-off-by: Marco Elver <elver@xxxxxxxxxx>
Signed-off-by: Borislav Petkov <bp@xxxxxxx>
Acked-by: Peter Zijlstra (Intel) <peterz@xxxxxxxxxxxxx>
Acked-by: Will Deacon <will@xxxxxxxxxx>
Link: https://lkml.kernel.org/r/20200521142047.169334-8-elver@xxxxxxxxxx
---
Documentation/dev-tools/kcsan.rst | 9 +--------
1 file changed, 1 insertion(+), 8 deletions(-)

diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
index f4b5766..ce4bbd9 100644
--- a/Documentation/dev-tools/kcsan.rst
+++ b/Documentation/dev-tools/kcsan.rst
@@ -8,8 +8,7 @@ approach to detect races. KCSAN's primary purpose is to detect `data races`_.
Usage
-----

-KCSAN is supported in both GCC and Clang. With GCC it requires version 7.3.0 or
-later. With Clang it requires version 7.0.0 or later.
+KCSAN requires Clang version 11 or later.

To enable KCSAN configure the kernel with::

@@ -121,12 +120,6 @@ the below options are available:
static __no_kcsan_or_inline void foo(void) {
...

- Note: Older compiler versions (GCC < 9) also do not always honor the
- ``__no_kcsan`` attribute on regular ``inline`` functions. If false positives
- with these compilers cannot be tolerated, for small functions where
- ``__always_inline`` would be appropriate, ``__no_kcsan_or_inline`` should be
- preferred instead.
-
* To disable data race detection for a particular compilation unit, add to the
``Makefile``::