tools/memory-model: Improve litmus-test documentation
authorPaul E. McKenney <paulmck@kernel.org>
Tue, 4 Aug 2020 00:19:54 +0000 (17:19 -0700)
committerPaul E. McKenney <paulmck@kernel.org>
Thu, 3 Sep 2020 16:51:01 +0000 (09:51 -0700)
commit984f272be9d7b2dd8b17e35d437e5da500b502ae
tree1a340f16ad72b12a37d5e1f5d19f6132512b8247
parentcc9628b45c9fa9b165a50dbb262928bc529bf35d
tools/memory-model: Improve litmus-test documentation

The current LKMM documentation says very little about litmus tests, and
worse yet directs people to the herd7 documentation for more information.
Now, the herd7 documentation is quite voluminous and educational,
but it is intended for people creating and modifying memory models,
not those attempting to use them.

This commit therefore updates README and creates a litmus-tests.txt
file that gives an overview of litmus-test format and describes ways of
modeling various special cases, illustrated with numerous examples.

[ paulmck: Add Alan Stern feedback. ]
[ paulmck: Apply Dave Chinner feedback. ]
[ paulmck: Apply Andrii Nakryiko feedback. ]
[ paulmck: Apply Johannes Weiner feedback. ]
Link: https://lwn.net/Articles/827180/
Reported-by: Dave Chinner <david@fromorbit.com>
Acked-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
tools/memory-model/Documentation/litmus-tests.txt [new file with mode: 0644]
tools/memory-model/README