Re: [PATCH locking/atomic 18/19] locking/atomic: Refrain from generating duplicate fallback kernel-doc

From: Paul E. McKenney
Date: Thu May 11 2023 - 16:25:45 EST


On Thu, May 11, 2023 at 10:01:42PM +0200, Peter Zijlstra wrote:
> On Thu, May 11, 2023 at 12:53:46PM -0700, Paul E. McKenney wrote:
> > Do you have an alternative suggestion for generating the kernel-doc?
> > The current lack of it is problematic.
>
> I've never found a lack of kernel-doc to be a problem. And I'm very much
> against complicating the scripts to add it.

I am sure that you have not recently found the lack of kernel-doc for
the atomic operations to be a problem, given that you wrote many of
these functions.

OK, you mentioned concerns about documentation people nitpicking. This
can be dealt with. The added scripting is not that large or complex.

> Also, there's Documentation/atomic_t.txt

Yes, if you very carefully read that document end to end, correctly
interpreting it all, you will know what you need to. Of course, first
you have to find it. And then you must avoid any lapses while reading
it while under pressure. Not particularly friendly to someone trying
to chase a bug.

Thanx, Paul