The following commit has been merged into the locking/urgent branch of tip:
Commit-ID: ea0484644e5b8486c8335f677fc1e2a4a5d76d3f
Gitweb: https://git.kernel.org/tip/ea0484644e5b8486c8335f677fc1e2a4a5d76d3f
Author: Paul E. McKenney <[email protected]>
AuthorDate: Thu, 04 Mar 2021 16:04:09 -08:00
Committer: Paul E. McKenney <[email protected]>
CommitterDate: Tue, 18 May 2021 10:58:14 -07:00
kcsan: Add pointer to access-marking.txt to data_race() bullet
This commit references tools/memory-model/Documentation/access-marking.txt
in the bullet introducing data_race(). The access-marking.txt file
gives advice on when data_race() should and should not be used.
Suggested-by: Akira Yokosawa <[email protected]>
Signed-off-by: Paul E. McKenney <[email protected]>
---
Documentation/dev-tools/kcsan.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
index d85ce23..8089466 100644
--- a/Documentation/dev-tools/kcsan.rst
+++ b/Documentation/dev-tools/kcsan.rst
@@ -106,7 +106,9 @@ the below options are available:
* KCSAN understands the ``data_race(expr)`` annotation, which tells KCSAN that
any data races due to accesses in ``expr`` should be ignored and resulting
- behaviour when encountering a data race is deemed safe.
+ behaviour when encountering a data race is deemed safe. Please see
+ ``tools/memory-model/Documentation/access-marking.txt`` in the kernel source
+ tree for more information.
* Disabling data race detection for entire functions can be accomplished by
using the function attribute ``__no_kcsan``::