tools/memory-model: Add locking.txt and glossary.txt to README

locking.txt and glossary.txt have been in LKMM's documentation for
quite a while.

Add them in README's introduction of docs and the list of docs at the
bottom.  Add access-marking.txt in the former as well.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Acked-by: Andrea Parri <parri.andrea@gmail.com>
Cc: Marco Elver <elver@google.com>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>

diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README
index 44e7dae73b29626decba66e6e7cabd123009b7fa..9999c1effdb65ae7501bec2c8809d3da5094d745 100644 (file)
--- a/tools/memory-model/Documentation/README
+++ b/tools/memory-model/Documentation/README
@@ -9,6 +9,8 @@ depending on what you know and what you would like to learn.  Please note
 that the documents later in this list assume that the reader understands
 the material provided by documents earlier in this list.
 
+If LKMM-specific terms lost you, glossary.txt might help you.
+
 o      You are new to Linux-kernel concurrency: simple.txt
 
 o      You have some background in Linux-kernel concurrency, and would
@@ -21,6 +23,9 @@ o     You are familiar with the Linux-kernel concurrency primitives
        that you need, and just want to get started with LKMM litmus
        tests:  litmus-tests.txt
 
+o      You would like to access lock-protected shared variables without
+       having their corresponding locks held:  locking.txt
+
 o      You are familiar with Linux-kernel concurrency, and would
        like a detailed intuitive understanding of LKMM, including
        situations involving more than two threads:  recipes.txt
@@ -28,6 +33,11 @@ o    You are familiar with Linux-kernel concurrency, and would
 o      You would like a detailed understanding of what your compiler can
        and cannot do to control dependencies:  control-dependencies.txt
 
+o      You would like to mark concurrent normal accesses to shared
+       variables so that intentional "racy" accesses can be properly
+       documented, especially when you are responding to complaints
+       from KCSAN:  access-marking.txt
+
 o      You are familiar with Linux-kernel concurrency and the use of
        LKMM, and would like a quick reference:  cheatsheet.txt
 
@@ -62,6 +72,9 @@ control-dependencies.txt
 explanation.txt
        Detailed description of the memory model.
 
+glossary.txt
+       Brief definitions of LKMM-related terms.
+
 herd-representation.txt
        The (abstract) representation of the Linux-kernel concurrency
        primitives in terms of events.
@@ -70,6 +83,10 @@ litmus-tests.txt
        The format, features, capabilities, and limitations of the litmus
        tests that LKMM can evaluate.
 
+locking.txt
+       Rules for accessing lock-protected shared variables outside of
+       their corresponding critical sections.
+
 ordering.txt
        Overview of the Linux kernel's low-level memory-ordering
        primitives by category.