linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: "Joel Fernandes (Google)" <joel@joelfernandes.org>,
	Boqun Feng <boqun.feng@gmail.com>,
	"Paul E. McKenney" <paulmck@kernel.org>
Cc: linux-kernel@vger.kernel.org, vpillai@digitalocean.com,
	Jonathan Corbet <corbet@lwn.net>,
	Alan Stern <stern@rowland.harvard.edu>,
	Andrea Parri <parri.andrea@gmail.com>,
	Will Deacon <will@kernel.org>,
	Peter Zijlstra <peterz@infradead.org>,
	Nicholas Piggin <npiggin@gmail.com>,
	David Howells <dhowells@redhat.com>,
	Jade Alglave <j.alglave@ucl.ac.uk>,
	Luc Maranget <luc.maranget@inria.fr>,
	Daniel Lustig <dlustig@nvidia.com>,
	linux-doc@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 3/3] Documentation/litmus-tests: Merge atomic's README into top-level one
Date: Sun, 10 May 2020 16:28:52 +0900	[thread overview]
Message-ID: <ee593aed-018b-7bd9-d841-72b1d038bd27@gmail.com> (raw)
In-Reply-To: <21e1ba24-22d0-8083-770c-53d320ba5420@gmail.com>

From 1aa2c25f0ad16382a5bc597cdbdcc817645e01cd Mon Sep 17 00:00:00 2001
From: Akira Yokosawa <akiyks@gmail.com>
Date: Sun, 10 May 2020 15:12:57 +0900
Subject: [PATCH 3/3] Documentation/litmus-tests: Merge atomic's README into top-level one

Where Documentation/litmus-tests/README lists RCU litmus tests,
Documentation/litmus-tests/atomic/README lists atomic litmus tests.
For symmetry, merge the latter into former, with some context
adjustment in the introduction.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
 Documentation/litmus-tests/README        | 19 +++++++++++++++++++
 Documentation/litmus-tests/atomic/README | 16 ----------------
 2 files changed, 19 insertions(+), 16 deletions(-)
 delete mode 100644 Documentation/litmus-tests/atomic/README

diff --git a/Documentation/litmus-tests/README b/Documentation/litmus-tests/README
index c4307ea9f996..ac0b270b456c 100644
--- a/Documentation/litmus-tests/README
+++ b/Documentation/litmus-tests/README
@@ -2,6 +2,25 @@
 LITMUS TESTS
 ============
 
+Each subdirectory contains litmus tests that are typical to describe the
+semantics of respective kernel APIs.
+For more information about how to "run" a litmus test or how to generate
+a kernel test module based on a litmus test, please see
+tools/memory-model/README.
+
+
+atomic (/atomic derectory)
+--------------------------
+
+Atomic-RMW+mb__after_atomic-is-stronger-than-acquire.litmus
+    Test that an atomic RMW followed by a smp_mb__after_atomic() is
+    stronger than a normal acquire: both the read and write parts of
+    the RMW are ordered before the subsequential memory accesses.
+
+Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus
+    Test that atomic_set() cannot break the atomicity of atomic RMWs.
+
+
 RCU (/rcu directory)
 --------------------
 
diff --git a/Documentation/litmus-tests/atomic/README b/Documentation/litmus-tests/atomic/README
deleted file mode 100644
index 714cf93816ea..000000000000
--- a/Documentation/litmus-tests/atomic/README
+++ /dev/null
@@ -1,16 +0,0 @@
-This directory contains litmus tests that are typical to describe the semantics
-of our atomic APIs. For more information about how to "run" a litmus test or
-how to generate a kernel test module based on a litmus test, please see
-tools/memory-model/README.
-
-============
-LITMUS TESTS
-============
-
-Atomic-RMW+mb__after_atomic-is-stronger-than-acquire
-	Test that an atomic RMW followed by a smp_mb__after_atomic() is
-	stronger than a normal acquire: both the read and write parts of
-	the RMW are ordered before the subsequential memory accesses.
-
-Atomic-RMW-ops-are-atomic-WRT-atomic_set.litmus
-	Test that atomic_set() cannot break the atomicity of atomic RMWs.
-- 
2.17.1



  parent reply	other threads:[~2020-05-10  7:28 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-23  1:57 [PATCH v2 1/4] Documentation: LKMM: Move MP+onceassign+derefonce to new litmus-tests/rcu/ Joel Fernandes (Google)
2020-03-23  1:57 ` [PATCH v2 2/4] Documentation: LKMM: Add litmus test for RCU GP guarantee where updater frees object Joel Fernandes (Google)
2020-03-23  1:57 ` [PATCH v2 3/4] Documentation: LKMM: Add litmus test for RCU GP guarantee where reader stores Joel Fernandes (Google)
2020-03-23  1:57 ` [PATCH v2 4/4] MAINTAINERS: Update maintainers for new Documentaion/litmus-tests/ Joel Fernandes (Google)
2020-03-23  6:18   ` Boqun Feng
2020-03-23  8:59   ` Andrea Parri
2020-03-23 17:35     ` Paul E. McKenney
2020-05-09  3:43 ` [PATCH v2 1/4] Documentation: LKMM: Move MP+onceassign+derefonce to new litmus-tests/rcu/ Akira Yokosawa
2020-05-10  7:21   ` [PATCH 0/3] tools/memory-model, Documentation/litmus-test: Sort out location of litmus test and README Akira Yokosawa
2020-05-10  7:23     ` [PATCH 1/3] tools/memory-model: Fix reference to litmus test in recipes.txt Akira Yokosawa
2020-05-10  7:24     ` [PATCH 2/3] Revert "Documentation: LKMM: Move MP+onceassign+derefonce to new litmus-tests/rcu/" Akira Yokosawa
2020-05-10  7:28     ` Akira Yokosawa [this message]
2020-05-10 12:57     ` [PATCH 0/3] tools/memory-model, Documentation/litmus-test: Sort out location of litmus test and README Andrea Parri
2020-05-11 17:33     ` Paul E. McKenney
2020-05-12  2:13       ` Joel Fernandes
2020-05-12 11:50         ` Akira Yokosawa
2020-05-12 12:19           ` Joel Fernandes
2020-05-12 14:19             ` Paul E. McKenney
2020-05-12 14:39               ` Akira Yokosawa
2020-05-12 15:40                 ` Joel Fernandes
2020-05-12 13:44         ` Alan Stern
2020-05-12 15:07     ` [PATCH 4/3] docs: litmus-tests: Clarify about the RCU pre-initialization test Akira Yokosawa
2020-05-12 15:25       ` Alan Stern
2020-05-12 15:41       ` Joel Fernandes
2020-05-12 16:30         ` Paul E. McKenney
2020-05-12 21:33           ` [PATCH RESEND 0/4] tools/memory-model, Documentation/litmus-test: Sort out, location of litmus test and README Akira Yokosawa
2020-05-12 21:36             ` [PATCH RESEND 1/4] tools/memory-model: Fix reference to litmus test in recipes.txt Akira Yokosawa
2020-05-12 21:37             ` [PATCH RESEND 2/4] Revert "Documentation: LKMM: Move MP+onceassign+derefonce to new litmus-tests/rcu/" Akira Yokosawa
2020-05-12 21:39             ` [PATCH RESEND 3/4] Documentation/litmus-tests: Merge atomic's README into top-level one Akira Yokosawa
2020-05-14  0:46               ` Boqun Feng
2020-05-14 17:16                 ` Paul E. McKenney
2020-05-14 22:03                   ` Akira Yokosawa
2020-05-14 22:45                     ` Paul E. McKenney
2020-05-15 15:01                       ` Akira Yokosawa
2020-05-15 15:05                         ` Paul E. McKenney
2020-05-16 17:02                           ` Paul E. McKenney
2020-05-12 21:40             ` [PATCH RESEND 4/4] docs: litmus-tests: Clarify about the RCU pre-initialization test Akira Yokosawa
2020-05-12 21:43           ` [PATCH 4/3] " Joel Fernandes
2020-05-12 21:49             ` Akira Yokosawa
2020-05-12 22:52               ` Joel Fernandes

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ee593aed-018b-7bd9-d841-72b1d038bd27@gmail.com \
    --to=akiyks@gmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dhowells@redhat.com \
    --cc=dlustig@nvidia.com \
    --cc=j.alglave@ucl.ac.uk \
    --cc=joel@joelfernandes.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luc.maranget@inria.fr \
    --cc=npiggin@gmail.com \
    --cc=parri.andrea@gmail.com \
    --cc=paulmck@kernel.org \
    --cc=peterz@infradead.org \
    --cc=stern@rowland.harvard.edu \
    --cc=vpillai@digitalocean.com \
    --cc=will@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).