Received-SPF: pass (google.com: domain of linux-kernel+bounces-180882-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Thu, 16 May 2024 12:02:50 +0200
From: Mark Rutland <mark.rutland@arm.com>
To: Peter Zijlstra <peterz@infradead.org>
Cc: Carlos Llamas <cmllamas@google.com>, Ingo Molnar <mingo@kernel.org>,
	Will Deacon <will@kernel.org>, Boqun Feng <boqun.feng@gmail.com>,
	Kees Cook <keescook@chromium.org>,
	"Paul E. McKenney" <paulmck@kernel.org>,
	Uros Bizjak <ubizjak@gmail.com>, Nhat Pham <nphamcs@gmail.com>,
	linux-kernel@vger.kernel.org, kernel-team@android.com,
	stable@vger.kernel.org, Arnd Bergmann <arnd@arndb.de>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: Re: [PATCH v2] locking/atomic: scripts: fix ${atomic}_sub_and_test()
 kerneldoc
Message-ID: <ZkXZyijVOdtxu763@J2N7QTR9R3>
References: <ZkRuMcao7lusrypL@J2N7QTR9R3>
 <20240515133844.3502360-1-cmllamas@google.com>
 <ZkXHxhhER-T6MhIX@J2N7QTR9R3>
 <20240516085310.GC24704@noisy.programming.kicks-ass.net>
 <20240516094920.GP12673@noisy.programming.kicks-ass.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20240516094920.GP12673@noisy.programming.kicks-ass.net>

On Thu, May 16, 2024 at 11:49:20AM +0200, Peter Zijlstra wrote:
> On Thu, May 16, 2024 at 10:53:10AM +0200, Peter Zijlstra wrote:
> > On Thu, May 16, 2024 at 10:45:58AM +0200, Mark Rutland wrote:
> > > On Wed, May 15, 2024 at 01:37:10PM +0000, Carlos Llamas wrote:
> > > > For ${atomic}_sub_and_test() the @i parameter is the value to subtract,
> > > > not add. Fix the typo in the kerneldoc template and generate the headers
> > > > with this update.
> > > > 
> > > > Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments")
> > > > Cc: Mark Rutland <mark.rutland@arm.com>
> > > > Cc: stable@vger.kernel.org
> > > > Suggested-by: Mark Rutland <mark.rutland@arm.com>
> > > > Reviewed-by: Kees Cook <keescook@chromium.org>
> > > > Signed-off-by: Carlos Llamas <cmllamas@google.com>
> > > > ---
> > > > 
> > > > Notes:
> > > >     v2: fix kerneldoc template instead, as pointed out by Mark
> > > 
> > > Thanks for this!
> > > 
> > > Acked-by: Mark Rutland <mark.rutland@arm.com>
> > > 
> > > Peter, Ingo, are you happy to queue this up in the tip tree?
> > 
> > Yep can do. I'll sit on it until after the merge window though.
> 
> Also, do we really want this in stable? It's just a silly doc change.

I think that we do, so that when people look at the generated docs for
stable kernels they see the right thing.

It *should* be a trivial backport, anyhow.

Mark.