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:   Sat, 13 May 2023 18:14:36 -0700
From:   "Paul E. McKenney" <paulmck@kernel.org>
To:     Akira Yokosawa <akiyks@gmail.com>
Cc:     Mark Rutland <mark.rutland@arm.com>, linux-kernel@vger.kernel.org,
        x86@kernel.org, linux-doc@vger.kernel.org, kernel-team@meta.com,
        Will Deacon <will@kernel.org>,
        Peter Zijlstra <peterz@infradead.org>,
        Boqun Feng <boqun.feng@gmail.com>
Subject: Re: [PATCH locking/atomic 18/19] locking/atomic: Refrain from
 generating duplicate fallback kernel-doc
Message-ID: <551c7820-1748-433b-8c42-daf777e202df@paulmck-laptop>
Reply-To: paulmck@kernel.org
References: <19135936-06d7-4705-8bc8-bb31c2a478ca@paulmck-laptop>
 <20230510181717.2200934-18-paulmck@kernel.org>
 <ZF0haDfyL3At3Ijw@FVFF77S0Q05N.cambridge.arm.com>
 <2a8b310c-3145-462b-a4c4-a130939da862@paulmck-laptop>
 <ZF48uBYKczItubrU@FVFF77S0Q05N>
 <b5498819-c2d4-414d-ba01-5373e749dc52@paulmck-laptop>
 <ZF5xXuPsrZEgAEEE@FVFF77S0Q05N>
 <e767dcc6-ea63-4ed8-9a15-9e5bb133fafc@paulmck-laptop>
 <b3956719-d478-4dc6-95fd-ec0744acc662@paulmck-laptop>
 <23195f15-7024-6fde-84f2-4cdd45c9abfc@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <23195f15-7024-6fde-84f2-4cdd45c9abfc@gmail.com>
Precedence: bulk

On Sun, May 14, 2023 at 08:58:00AM +0900, Akira Yokosawa wrote:
> Hi,
> 
> On Fri, 12 May 2023 19:11:15 -0700, Paul E. McKenney wrote:
> [...]
> 
> > 
> > And here is a rough first cut:
> > 
> > git://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git tags/fallback-rework-kernel-doc.2023.05.12a
> > 
> > Or via HTML:
> > 
> > https://git.kernel.org/pub/scm/linux/kernel/git/paulmck/linux-rcu.git/log/?h=fallback-rework-kernel-doc.2023.05.12a
> 
> Running "./scripts/kernel-doc -none include/linux/atomic/atomic-arch-fallback.h"
> on the tag emits a lot of warnings.
> 
> Looks like there are kernel-doc comments who don't have a corresponding
> function signature next to them.
> 
>     /**
>      * function_name() - Brief description of function.
>      * @arg1: Describe the first argument.
>      * @arg2: Describe the second argument.
>      *        One can provide multiple line descriptions
>      *        for arguments.
>      *
>      * A longer description, with more discussion of the function function_name()
>      * that might be useful to those using or modifying it. Begins with an
>      * empty comment line, and may include additional embedded empty
>      * comment lines.
>      */
>     int function_name(int arg1, int arg2)  <---
> 
> Note that the kernel-doc script ignores #ifdef -- #else.

Me, I was thinking in terms of making this diagnostic ignore
include/linux/atomic/atomic-arch-fallback.h.  ;-)

The actual definitions are off in architecture-specific files, and
the kernel-doc headers could be left there.  But there are benefits to
automatically generating all of them.

Another approach might be to put a "it is OK for the definition to
be elsewhere" comment following those kernel-doc headers.

Any other ways to make this work?  For me, the option of making this
diagnostic ignore include/linux/atomic/atomic-arch-fallback.h has
considerable attraction.

> BTW, I couldn't checkout the tag so downloaded the tar ball via
> HTML.

Tags can be a bit annoying in that way.  I will provide a branch next
time.

							Thanx, Paul

>         Thanks, Akira
> 
> > 
> > Thoughts?
> > 
> > In the meantime, enjoy the weekend!
> > 
> > 							Thanx, Paul