| Message ID | 20200624145721.2590327-6-lee.jones@linaro.org (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | Fix a bunch of W=1 warnings in Backlight | expand |
On Wed, Jun 24, 2020 at 03:57:18PM +0100, Lee Jones wrote: > Kerneldoc syntax is used, but not complete. Descriptions required. > > Prevents warnings like: > > drivers/video/backlight/ili922x.c:298: warning: Function parameter or member 'spi' not described in 'ili922x_reg_dump' > > Cc: <stable@vger.kernel.org> > Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> > Cc: Software Engineering <sbabic@denx.de> > Signed-off-by: Lee Jones <lee.jones@linaro.org> > --- > drivers/video/backlight/ili922x.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c > index cd41433b87aeb..26193f38234e7 100644 > --- a/drivers/video/backlight/ili922x.c > +++ b/drivers/video/backlight/ili922x.c > @@ -295,6 +295,8 @@ static int ili922x_write(struct spi_device *spi, u8 reg, u16 value) > #ifdef DEBUG > /** > * ili922x_reg_dump - dump all registers > + * > + * @spi: pointer to the controller side proxy for an SPI slave device Similar to previous... and I also noticed that there are several other existing @spi descriptions in this file and it would be good to make them consistent. Daniel. > */ > static void ili922x_reg_dump(struct spi_device *spi) > { > -- > 2.25.1 >
On Thu, 25 Jun 2020, Daniel Thompson wrote: > On Wed, Jun 24, 2020 at 03:57:18PM +0100, Lee Jones wrote: > > Kerneldoc syntax is used, but not complete. Descriptions required. > > > > Prevents warnings like: > > > > drivers/video/backlight/ili922x.c:298: warning: Function parameter or member 'spi' not described in 'ili922x_reg_dump' > > > > Cc: <stable@vger.kernel.org> > > Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> > > Cc: Software Engineering <sbabic@denx.de> > > Signed-off-by: Lee Jones <lee.jones@linaro.org> > > --- > > drivers/video/backlight/ili922x.c | 2 ++ > > 1 file changed, 2 insertions(+) > > > > diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c > > index cd41433b87aeb..26193f38234e7 100644 > > --- a/drivers/video/backlight/ili922x.c > > +++ b/drivers/video/backlight/ili922x.c > > @@ -295,6 +295,8 @@ static int ili922x_write(struct spi_device *spi, u8 reg, u16 value) > > #ifdef DEBUG > > /** > > * ili922x_reg_dump - dump all registers > > + * > > + * @spi: pointer to the controller side proxy for an SPI slave device > > Similar to previous... and I also noticed that there are several other > existing @spi descriptions in this file and it would be good to make > them consistent. I've fixed this and applied the patch.
diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c index cd41433b87aeb..26193f38234e7 100644 --- a/drivers/video/backlight/ili922x.c +++ b/drivers/video/backlight/ili922x.c @@ -295,6 +295,8 @@ static int ili922x_write(struct spi_device *spi, u8 reg, u16 value) #ifdef DEBUG /** * ili922x_reg_dump - dump all registers + * + * @spi: pointer to the controller side proxy for an SPI slave device */ static void ili922x_reg_dump(struct spi_device *spi) {
Kerneldoc syntax is used, but not complete. Descriptions required. Prevents warnings like: drivers/video/backlight/ili922x.c:298: warning: Function parameter or member 'spi' not described in 'ili922x_reg_dump' Cc: <stable@vger.kernel.org> Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> Cc: Software Engineering <sbabic@denx.de> Signed-off-by: Lee Jones <lee.jones@linaro.org> --- drivers/video/backlight/ili922x.c | 2 ++ 1 file changed, 2 insertions(+)