Received-SPF: pass (google.com: domain of linux-kernel+bounces-179902-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Wed, 15 May 2024 13:16:38 +0000
From: Carlos Llamas <cmllamas@google.com>
To: Mark Rutland <mark.rutland@arm.com>
Cc: Peter Zijlstra <peterz@infradead.org>,
	Kees Cook <keescook@chromium.org>,
	"Paul E. McKenney" <paulmck@kernel.org>,
	Ingo Molnar <mingo@kernel.org>, Uros Bizjak <ubizjak@gmail.com>,
	linux-kernel@vger.kernel.org, kernel-team@android.com,
	stable@vger.kernel.org, Arnd Bergmann <arnd@arndb.de>
Subject: Re: [PATCH] locking/atomic: fix trivial typo in comment
Message-ID: <ZkS1tv56BNi-l6wC@google.com>
References: <20240514224625.3280818-1-cmllamas@google.com>
 <ZkRuMcao7lusrypL@J2N7QTR9R3>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <ZkRuMcao7lusrypL@J2N7QTR9R3>

On Wed, May 15, 2024 at 10:11:29AM +0200, Mark Rutland wrote:
> Hi Carlos,
> 
> On Tue, May 14, 2024 at 10:46:03PM +0000, Carlos Llamas wrote:
> > For atomic_sub_and_test() the @i parameter is the value to subtract, not
> > add. Fix the kerneldoc comment accordingly.
> > 
> > Fixes: ad8110706f38 ("locking/atomic: scripts: generate kerneldoc comments")
> > Cc: Mark Rutland <mark.rutland@arm.com>
> > Cc: stable@vger.kernel.org
> > Signed-off-by: Carlos Llamas <cmllamas@google.com>
> > ---
> >  include/linux/atomic/atomic-instrumented.h | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/include/linux/atomic/atomic-instrumented.h b/include/linux/atomic/atomic-instrumented.h
> > index debd487fe971..12b558c05384 100644
> > --- a/include/linux/atomic/atomic-instrumented.h
> > +++ b/include/linux/atomic/atomic-instrumented.h
> > @@ -1349,7 +1349,7 @@ atomic_try_cmpxchg_relaxed(atomic_t *v, int *old, int new)
> >  
> >  /**
> >   * atomic_sub_and_test() - atomic subtract and test if zero with full ordering
> > - * @i: int value to add
> > + * @i: int value to subtract
> >   * @v: pointer to atomic_t
> 
> Whoops; sorry about that.
> 
> The atomic headers are generated, and this kerneldoc comment is
> generated from the template in scripts/atomic/kerneldoc/sub_and_test

Oh I see. Sorry, I wasn't aware of this.

> 
> You'll need to modify that then run:
> 
>   sh scripts/atomic/gen-atomics.sh
> 
> ... to regenerate all the affected instances of ${atomic}_sub_and_test()

Ok, let me go do that. Thanks!

> 
> Thanks,
> Mark.