Thread (28 messages) 28 messages, 3 authors, 2020-07-06

Re: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args

From: Lee Jones <hidden>
Date: 2020-07-06 07:12:59
Also in: dri-devel, linux-arm-kernel, lkml, stable

On Thu, 25 Jun 2020, Daniel Thompson wrote:
On Wed, Jun 24, 2020 at 03:57:16PM +0100, Lee Jones wrote:
quoted
Kerneldoc syntax is used, but not complete.  Descriptions required.

Prevents warnings like:

 drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 's' not described in 'CHECK_FREQ_REG'
 drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 'x' not described in 'CHECK_FREQ_REG'

Cc: <redacted>
Cc: Bartlomiej Zolnierkiewicz <redacted>
Cc: Software Engineering <redacted>
Signed-off-by: Lee Jones <redacted>
---
 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 9c5aa3fbb2842..8cb4b9d3c3bba 100644
--- a/drivers/video/backlight/ili922x.c
+++ b/drivers/video/backlight/ili922x.c
@@ -107,6 +107,8 @@
  *	lower frequency when the registers are read/written.
  *	The macro sets the frequency in the spi_transfer structure if
  *	the frequency exceeds the maximum value.
+ * @s: pointer to controller side proxy for an SPI slave device
What's wrong with "a pointer to an SPI device"?
I've fixed this and applied the patch.

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help