From: Paul E. McKenney Date: Fri, 5 Mar 2021 00:04:09 +0000 (-0800) Subject: kcsan: Add pointer to access-marking.txt to data_race() bullet X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=ea0484644e5b8486c8335f677fc1e2a4a5d76d3f;p=linux.git 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 Signed-off-by: Paul E. McKenney --- diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst index d85ce238ace78..80894664a44c8 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``::