diff options
| author | Boqun Feng <boqun.feng@gmail.com> | 2021-10-25 22:54:15 +0800 |
|---|---|---|
| committer | Paul E. McKenney <paulmck@kernel.org> | 2021-11-30 17:47:08 -0800 |
| commit | b47c05ecf60bd8743ad8c0ee510d3e1c060529d7 (patch) | |
| tree | be5c9ae6e59bea9654527b37e7cc84046a0f4c7f /tools/memory-model | |
| parent | ddfe12944e84830fe7dc490992e55b4fa773555e (diff) | |
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>
Diffstat (limited to 'tools/memory-model')
| -rw-r--r-- | tools/memory-model/README | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/tools/memory-model/README b/tools/memory-model/README index 9a84c45504ab..9edd402704c4 100644 --- a/tools/memory-model/README +++ b/tools/memory-model/README @@ -195,6 +195,18 @@ litmus-tests are listed in litmus-tests/README. A great deal more litmus tests are available at https://github.com/paulmckrcu/litmus. + By "representative", it means the one in the litmus-tests + directory is: + + 1) simple, the number of threads should be relatively + small and each thread function should be relatively + simple. + 2) orthogonal, there should be no two litmus tests + describing the same aspect of the memory model. + 3) textbook, developers can easily copy-paste-modify + the litmus tests to use the patterns on their own + code. + lock.cat Provides a front-end analysis of lock acquisition and release, for example, associating a lock acquisition with the preceding |