Received-SPF: pass (google.com: domain of linux-kernel+bounces-207102-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Sat, 8 Jun 2024 08:48:46 -0700
From: "Paul E. McKenney" <paulmck@kernel.org>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: linux-kernel@vger.kernel.org, linux-arch@vger.kernel.org,
	kernel-team@meta.com, mingo@kernel.org, stern@rowland.harvard.edu,
	parri.andrea@gmail.com, will@kernel.org, peterz@infradead.org,
	boqun.feng@gmail.com, npiggin@gmail.com, dhowells@redhat.com,
	j.alglave@ucl.ac.uk, luc.maranget@inria.fr,
	Marco Elver <elver@google.com>, Daniel Lustig <dlustig@nvidia.com>,
	Joel Fernandes <joel@joelfernandes.org>
Subject: Re: [PATCH memory-model 3/3] tools/memory-model: Add KCSAN LF
 mentorship session citation
Message-ID: <6bb5f789-f143-493c-a804-62b7c81dabb0@paulmck-laptop>
Reply-To: paulmck@kernel.org
References: <b290acd5-074f-4e17-a8bf-b444e553d986@paulmck-laptop>
 <20240604221419.2370127-3-paulmck@kernel.org>
 <42fa4660-b3bf-4d09-bbad-064f9d4cc727@gmail.com>
 <f11f7230-7c16-45a3-83be-9aba32e10a3b@paulmck-laptop>
 <3c5a53e2-b5a9-4197-97a3-247abb7f3061@gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <3c5a53e2-b5a9-4197-97a3-247abb7f3061@gmail.com>

On Sat, Jun 08, 2024 at 08:38:12AM +0900, Akira Yokosawa wrote:
> On 2024/06/05 13:02, Paul E. McKenney wrote:
> > On Wed, Jun 05, 2024 at 10:57:27AM +0900, Akira Yokosawa wrote:
> >> On Tue,  4 Jun 2024 15:14:19 -0700, Paul E. McKenney wrote:
> >>> Add a citation to Marco's LF mentorship session presentation entitled
> >>> "The Kernel Concurrency Sanitizer"
> >>>
> >>> [ paulmck: Apply Marco Elver feedback. ]
> >>>
> >>> Reported-by: Marco Elver <elver@google.com>
> >>> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
> >>> Cc: Alan Stern <stern@rowland.harvard.edu>
> >>> Cc: Andrea Parri <parri.andrea@gmail.com>
> >>> Cc: Will Deacon <will@kernel.org>
> >>> Cc: Peter Zijlstra <peterz@infradead.org>
> >>> Cc: Boqun Feng <boqun.feng@gmail.com>
> >>> Cc: Nicholas Piggin <npiggin@gmail.com>
> >>> Cc: David Howells <dhowells@redhat.com>
> >>> Cc: Jade Alglave <j.alglave@ucl.ac.uk>
> >>> Cc: Luc Maranget <luc.maranget@inria.fr>
> >>> Cc: Akira Yokosawa <akiyks@gmail.com>
> >>
> >> Paul,
> >>
> >> While reviewing this, I noticed that
> >> tools/memory-model/Documentation/README has no mention of
> >> access-marking.txt.
> >>
> >> It has no mention of glossary.txt or locking.txt, either.
> >>
> >> I'm not sure where are the right places in README for them.
> >> Can you update it in a follow-up change?
> >>
> >> Anyway, for this change,
> >>
> >> Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
> > 
> > Thank you, and good catch!  Does the patch below look appropriate?
> 
> Well, I must say this is not what I expected.
> Please see below.

OK, I was clearly in way too much of a hurry when doing this, and please
accept my apologies for my inattention.  I am therefore going to do
what I should have done in the first place, which is to ask you if you
would like to send a patch fixing this.  If so, I would be quite happy
to replace mine with yours.

							Thanx, Paul

> > ------------------------------------------------------------------------
> > 
> > commit 834b22ba762fb59024843a64554d38409aaa82ec
> > Author: Paul E. McKenney <paulmck@kernel.org>
> > Date:   Tue Jun 4 20:59:35 2024 -0700
> > 
> >     tools/memory-model: Add access-marking.txt to README
> >     
> >     Given that access-marking.txt exists, this commit makes it easier to find.
> >     
> >     Reported-by: Akira Yokosawa <akiyks@gmail.com>
> >     Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
> > 
> > diff --git a/tools/memory-model/Documentation/README b/tools/memory-model/Documentation/README
> > index db90a26dbdf40..304162743a5b8 100644
> > --- a/tools/memory-model/Documentation/README
> > +++ b/tools/memory-model/Documentation/README
> > @@ -47,6 +47,10 @@ DESCRIPTION OF FILES
> >  README
> >  	This file.
> >  
> > +access-marking.txt
> > +	Guidelines for marking intentionally concurrent accesses to
> > +	shared memory.
> > +
> >  cheatsheet.txt
> >  	Quick-reference guide to the Linux-kernel memory model.
> >
> 
> What I expected was an entry in the bullet list in the upper half
> of README which mentions access-marking.txt along with the update of
> alphabetical list of files.
> 
> Updating the latter wouldn't worth bothering you.
> 
> And you are missing another comment WRT glossary.txt and locking.txt. ;-)
> 
> Let me suggest an idea of their positions in the bullet list where the
> ordering is important.  Looks reasonable to you ?
> 
>   o   simple.txt
>   o   ordering.txt
>   o   locking.txt               <--new
>   o   litmus-test.txt
>   o   recipes.txt
>   o   control-dependencies.txt
>   o   access-marking.txt        <--new
>   o   cheatsheet.txt
>   o   explanation.txt
>   o   references.txt
>   o   glossary.txt              <--new
> 
> Have I made my point clear enough?
> 
>         Thanks, Akira