[PATCH 4/3] docs: litmus-tests: Clarify about the RCU pre-initialization test

From: Google
Date: Mon May 11 2020 - 22:06:46 EST


Since this test returned to tools/memory-model/, make sure that it is
at least referenced from Documentation/litmus-tests/'s README.

Co-developed-by: Joel Fernandes (Google) <joel@xxxxxxxxxxxxxxxxx>
Co-developed-by: Akira Yokosawa <akiyks@xxxxxxxxx>
[Alan: grammar nit]
Suggested-by: Alan Stern <stern@xxxxxxxxxxxxxxxxxxx>
Signed-off-by: Joel Fernandes (Google) <joel@xxxxxxxxxxxxxxxxx>
Signed-off-by: Akira Yokosawa <akiyks@xxxxxxxxx>
---
I said in the earlier message:

> The explanation under tools/memory-model/litmus-tests/README also need the same
> rewording.

, but obviously I was confused. It is good as is.

This is on top of my earlier patch series.

Joel, Alan, does this work with you?

Thanks, Akira
--
Documentation/litmus-tests/README | 4 ++++
1 file changed, 4 insertions(+)

diff --git a/Documentation/litmus-tests/README b/Documentation/litmus-tests/README
index ac0b270b456c..b79e640214b9 100644
--- a/Documentation/litmus-tests/README
+++ b/Documentation/litmus-tests/README
@@ -24,6 +24,10 @@ Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus
RCU (/rcu directory)
--------------------

+MP+onceassign+derefonce.litmus (under tools/memory-model/litmus-tests/)
+ Demonstrates the use of rcu_assign_pointer() and rcu_dereference() to
+ ensure that an RCU reader will not see pre-initialization garbage.
+
RCU+sync+read.litmus
RCU+sync+free.litmus
Both the above litmus tests demonstrate the RCU grace period guarantee
--
2.17.1