Commit 117232c0 authored by Akira Yokosawa's avatar Akira Yokosawa Committed by Paul E. McKenney
Browse files

kcsan: Use URL link for pointing access-marking.txt 



For consistency within kcsan.rst, use a URL link as the same as in
section "Data Races".

Acked-by: default avatarMarco Elver <elver@google.com>
Signed-off-by: default avatarAkira Yokosawa <akiyks@gmail.com>
Signed-off-by: default avatarPaul E. McKenney <paulmck@kernel.org>
parent b930226f

Documentation/dev-tools/kcsan.rst

+3 −2
Original line number Diff line number Diff line
@@ -89,8 +89,7 @@ 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.  Please see

  ``tools/memory-model/Documentation/access-marking.txt`` in the kernel source

  tree for more information.

  `"Marking Shared-Memory Accesses" in the LKMM`_ for more information.



* Disabling data race detection for entire functions can be accomplished by

  using the function attribute ``__no_kcsan``::
@@ -112,6 +111,8 @@ the below options are available: 


    KCSAN_SANITIZE := n



.. _"Marking Shared-Memory Accesses" in the LKMM: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/memory-model/Documentation/access-marking.txt



Furthermore, it is possible to tell KCSAN to show or hide entire classes of

data races, depending on preferences. These can be changed via the following

Kconfig options: