Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 7 Apr 2023 17:49:02 -0700
From:   "Paul E. McKenney" <paulmck@kernel.org>
To:     Jonas Oberhauser <jonas.oberhauser@huaweicloud.com>
Cc:     Joel Fernandes <joel@joelfernandes.org>,
        Alan Stern <stern@rowland.harvard.edu>,
        linux-kernel@vger.kernel.org, Boqun Feng <boqun.feng@gmail.com>,
        Jade Alglave <j.alglave@ucl.ac.uk>,
        Luc Maranget <luc.maranget@inria.fr>,
        Peter Zijlstra <peterz@infradead.org>,
        Will Deacon <will.deacon@arm.com>,
        Akira Yokosawa <akiyks@gmail.com>,
        Andrea Parri <parri.andrea@gmail.com>,
        Daniel Lustig <dlustig@nvidia.com>,
        David Howells <dhowells@redhat.com>,
        Jonas Oberhauser <jonas.oberhauser@huawei.com>,
        linux-arch@vger.kernel.org, Nicholas Piggin <npiggin@gmail.com>,
        Paul =?iso-8859-1?Q?Heidekr=FCger?= <paul.heidekrueger@in.tum.de>,
        Will Deacon <will@kernel.org>
Subject: Re: Litmus test names
Message-ID: <d32901a8-3a07-440c-9089-36b37c3f04e5@paulmck-laptop>
Reply-To: paulmck@kernel.org
References: <ea9376b4-4b3d-48ee-9c27-ad8de8a7b5cb@paulmck-laptop>
 <3908932E-17D4-4B87-AB0C-D10564F10623@joelfernandes.org>
 <159545c3-0093-3cbd-e822-7298ae764966@huaweicloud.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <159545c3-0093-3cbd-e822-7298ae764966@huaweicloud.com>
Precedence: bulk

On Fri, Apr 07, 2023 at 03:05:01PM +0200, Jonas Oberhauser wrote:
> 
> 
> On 4/7/2023 2:12 AM, Joel Fernandes wrote:
> > 
> > 
> > > On Apr 6, 2023, at 6:34 PM, Paul E. McKenney <paulmck@kernel.org> wrote:
> > > 
> > > ﻿On Thu, Apr 06, 2023 at 05:36:13PM -0400, Alan Stern wrote:
> > > > Paul:
> > > > 
> > > > I just saw that two of the files in
> > > > tools/memory-model/litmus-tests have
> > > > almost identical names:
> > > > 
> > > >  Z6.0+pooncelock+pooncelock+pombonce.litmus
> > > >  Z6.0+pooncelock+poonceLock+pombonce.litmus
> > > > 
> > > > They differ only by a lower-case 'l' vs. a capital 'L'.  It's
> > > > not at all
> > > > easy to see, and won't play well in case-insensitive filesystems.
> > > > 
> > > > Should one of them be renamed?
> > > 
> > > Quite possibly!
> > > 
> > > The "L" denotes smp_mb__after_spinlock().  The only code difference
> > > between these is that Z6.0+pooncelock+poonceLock+pombonce.litmus has
> > > smp_mb__after_spinlock() and Z6.0+pooncelock+pooncelock+pombonce.litmus
> > > does not.
> > > 
> > > Suggestions for a better name?  We could capitalize all the letters
> > > in LOCK, I suppose...
> 
> I don't think capitalizing LOCK is helpful.

Greek font, then?  (Sorry, couldn't resist...)

> To be honest, almost all the names are extremely cryptic to newcomers like
> me (like, what does Z6.0 mean? Is it some magic incantation?).
> And that's not something that's easy to fix.

All too true on all counts.  Some of the names abbreviate the litmus
test itself, and there are multiple encodings depending one who/what
generated the test in question.  Others of the names relate to who came
up with them or the code from which they are derived.

New allegedly universal naming schemes have a rather short half-life.

What would be cool would be a way to structurally compare litmus tests.
I bet that there are quite a few duplicates, for example.

> The only use case I can think of for spending time improving the names is
> that sometimes you wanna say something like "oh, this is like
> Z6.0+pooncelock+pooncelockmb+pombonce". And then people can look up what
> that is.
> For that, it's important that the names are easy to disambiguate by humans,
> and I think Joel's suggestion is an improvement.
> (and it also fixes the issue brought up by Alan about case-insensitive file
> systems)
> 
> > 
> > Z6.0+pooncelock+pooncelockmb+pombonce.litmus ?

I am OK with this one, but then again, I was also OK with the original
Z6.0+pooncelock+poonceLock+pombonce.litmus.  ;-)

Would someone like to to a "git mv" send the resulting patch?

							Thanx, Paul