[PATCH 1/4] tools/memory-model: docs/README: Update introduction of locking.txt
Akira Yokosawa <[email protected]>
| Newsgroups | dev.linux.lists.lkmm |
|---|---|
| Message-ID | <[email protected]> |
Commit 9bc931e9e161 ("tools/memory-model: Add locking.txt and
glossary.txt to README") failed to mention the relation of the "Locking"
section in recipes.txt and locking.txt.
The latter is a detailed version of the former intended to be read on
its own.
Reword the description in README and add notes in locking.txt and
recipes.txt to clarify their relationship.
Signed-off-by: Akira Yokosawa <[email protected]>
---
tools/memory-model/Documentation/README | 7 +++++--
tools/memory-model/Documentation/locking.txt | 5 +++++
tools/memory-model/Documentation/recipes.txt | 4 ++++
3 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README
index 9999c1effdb6..43602f7822ec 100644
--- a/tools/memory-model/Documentation/README
+++ b/tools/memory-model/Documentation/README
@@ -23,8 +23,11 @@ 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 Your immediate concern is to access lock-protected shared variables
+ without holding their corresponding locks: locking.txt
+
+ While it is an expanded version of section "Locking" in recipes.txt,
+ it is supposed to be readable on its own.
o You are familiar with Linux-kernel concurrency, and would
like a detailed intuitive understanding of LKMM, including
diff --git a/tools/memory-model/Documentation/locking.txt b/tools/memory-model/Documentation/locking.txt
index 65c898c64a93..b29b3a978df3 100644
--- a/tools/memory-model/Documentation/locking.txt
+++ b/tools/memory-model/Documentation/locking.txt
@@ -1,3 +1,8 @@
+[!] Note:
+ This is an expanded version of section "Locking" in recipes.txt
+ focusing on accessing lock-protected shared variables without
+ holding their corresponding locks.
+
Locking
=======
diff --git a/tools/memory-model/Documentation/recipes.txt b/tools/memory-model/Documentation/recipes.txt
index 03f58b11c252..ce531767adfd 100644
--- a/tools/memory-model/Documentation/recipes.txt
+++ b/tools/memory-model/Documentation/recipes.txt
@@ -61,6 +61,10 @@ usual) some things to be careful of:
Locking
-------
+[!] Note:
+ locking.txt expands on this section, focusing on accessing lock-
+ protected shared variables without holding their corresponding locks.
+
Locking is well-known and straightforward, at least if you don't think
about it too hard. And the basic rule is indeed quite simple: Any CPU that
has acquired a given lock sees any changes previously seen or made by any
--
2.34.1