Skip to content

Commit b47c05e

Browse files
fbqpaulmckrcu
authored andcommitted
tools/memory-model: doc: Describe the requirement of the litmus-tests directory
It's better that we have some "standard" about which test should be put in the litmus-tests directory because it helps future contributors understand whether they should work on litmus-tests in kernel or Paul's GitHub repo. Therefore explain a little bit on what a "representative" litmus test is. Signed-off-by: Boqun Feng <boqun.feng@gmail.com> Acked-by: Peter Zijlstra (Intel) <peterz@infradead.org> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
1 parent ddfe129 commit b47c05e

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

tools/memory-model/README

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,18 @@ litmus-tests
195195
are listed in litmus-tests/README. A great deal more litmus
196196
tests are available at https://github.com/paulmckrcu/litmus.
197197

198+
By "representative", it means the one in the litmus-tests
199+
directory is:
200+
201+
1) simple, the number of threads should be relatively
202+
small and each thread function should be relatively
203+
simple.
204+
2) orthogonal, there should be no two litmus tests
205+
describing the same aspect of the memory model.
206+
3) textbook, developers can easily copy-paste-modify
207+
the litmus tests to use the patterns on their own
208+
code.
209+
198210
lock.cat
199211
Provides a front-end analysis of lock acquisition and release,
200212
for example, associating a lock acquisition with the preceding

0 commit comments

Comments
 (0)