Re: [PATCH v1 2/2] gpiolib: Up to date the kernel documentation

From: Andy Shevchenko
Date: Wed Apr 03 2024 - 09:25:50 EST


On Wed, Apr 03, 2024 at 02:59:32PM +0200, Bartosz Golaszewski wrote:
> On Tue, Mar 26, 2024 at 7:12 PM Andy Shevchenko
> <andriy.shevchenko@xxxxxxxxxxxxxxx> wrote:
> >
> > There are several issues:
> >
> > - Reference to the non-existing or only single functions out of possible
> > callees
> >
> > - No return section
> >
> > $ scripts/kernel-doc -v -none -Wall drivers/gpio/gpiolib* 2>&1 | grep -w warning | wc -l
> > 67
> >
> > - Reference to NULL as %NULL in a few cases
> >
> > - Explicit reference to error codes as Exxx or %Exxx and
> > numbers with leading %
> >
> > - Spelling of gpio, irq, SOC (in different capitalization)
> >
> > - Unaligned style of irqchip, gpiochip references
> >
> > - Unaligned style of NOTE, FIXME, and TODO
> >
> > Fix all these. While at it, fix multi-line comment style as well.
> >
> > Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
>
> Could you split it into separate patches by subject (one for
> capitalization, one for %NULL, etc.)? As is, it's a huge dump that's
> hard to review.

Sure.

--
With Best Regards,
Andy Shevchenko