2020-05-12 21:44:45

by Akira Yokosawa

[permalink] [raw]
Subject: [PATCH RESEND 4/4] docs: litmus-tests: Clarify about the RCU pre-initialization test

From c2d6a0afad370c6fda136704bac9b1ee9557d0eb Mon Sep 17 00:00:00 2001
From: "Joel Fernandes (Google)" <[email protected]>
Date: Mon, 11 May 2020 22:06:46 -0400
Subject: [PATCH RESEND 4/4] docs: litmus-tests: Clarify about the RCU pre-initialization test

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) <[email protected]>
Co-developed-by: Akira Yokosawa <[email protected]>
[Alan: grammar nit]
Suggested-by: Alan Stern <[email protected]>
Signed-off-by: Joel Fernandes (Google) <[email protected]>
Signed-off-by: Akira Yokosawa <[email protected]>
---
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