Re: [PATCH memory-model 3/8] tools/memory-model: Document categories of ordering primitives

From: Paul E. McKenney
Date: Fri Nov 06 2020 - 14:11:51 EST


On Fri, Nov 06, 2020 at 11:56:54AM -0500, Alan Stern wrote:
> On Thu, Nov 05, 2020 at 02:00:12PM -0800, paulmck@xxxxxxxxxx wrote:
> > From: "Paul E. McKenney" <paulmck@xxxxxxxxxx>
> >
> > The Linux kernel has a number of categories of ordering primitives, which
> > are recorded in the LKMM implementation and hinted at by cheatsheet.txt.
> > But there is no overview of these categories, and such an overview
> > is needed in order to understand multithreaded LKMM litmus tests.
> > This commit therefore adds an ordering.txt as well as extracting a
> > control-dependencies.txt from memory-barriers.txt. It also updates the
> > README file.
> >
> > [ paulmck: Apply Akira Yokosawa file-placement feedback. ]
> > [ paulmck: Apply Alan Stern feedback. ]
> > [ paulmck: Apply self-review feedback. ]
> > Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxx>
> > ---
> > diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README
> > index 2d9539f..a50ea81 100644
> > --- a/tools/memory-model/Documentation/README
> > +++ b/tools/memory-model/Documentation/README
>
> > @@ -41,13 +50,21 @@ README
> > cheatsheet.txt
> > Quick-reference guide to the Linux-kernel memory model.
> >
> > +control-dependencies.txt
> > + Guide to preventing compiler optimizations from destroying
> > + your control dependencies.
> > +
> > explanation.txt
> > - Detailed description of the memory model.
> > + Detailed description of the memory model in detail.
>
> A redundantly redundant change.

I will revert the reversion of the removal of the added detail "in
detail". ;-)

Good catch, thank you!

Thanx, Paul