diff options
| author |   Paul E. McKenney <paulmck@kernel.org> | 2021-03-04 16:04:09 -0800 |
|---|---|---|
| committer | Paul E. McKenney <paulmck@kernel.org> | 2021-05-18 10:58:14 -0700 |
| commit | ea0484644e5b8486c8335f677fc1e2a4a5d76d3f (patch) | |
| tree | 9ec78a9a7caa3cb9a5e122500d37b784b2aa3867 /Documentation/dev-tools | |
| parent | kcsan: Fix debugfs initcall return type (diff) | |
| download | linux-dev-ea0484644e5b8486c8335f677fc1e2a4a5d76d3f.tar.xz linux-dev-ea0484644e5b8486c8335f677fc1e2a4a5d76d3f.zip | |
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 <akiyks@gmail.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Diffstat (limited to 'Documentation/dev-tools')
| -rw-r--r-- | Documentation/dev-tools/kcsan.rst | 4 |
1 files changed, 3 insertions, 1 deletions
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``:: |