[PATCH tip/core/rcu 01/10] kcsan: Add pointer to access-marking.txt to data_race() bullet

From: Paul E. McKenney
Date: Tue May 11 2021 - 19:24:13 EST


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 <akiyks@xxxxxxxxx>
Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxx>
---
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 d85ce238ace7..80894664a44c 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``::
--
2.31.1.189.g2e36527f23