Re: [PATCH memory-model 3/3] tools/memory-model: Add KCSAN LF mentorship session citation

[Akira Yokosawa <akiyks@gmail.com>]

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.

> 
> 							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