| Message ID | 20231206174525.14960-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2] backlight: ili922x: drop kernel-doc for local macros | expand |
On Wed, Dec 06, 2023 at 09:45:25AM -0800, Randy Dunlap wrote: > Don't use kernel-doc notation for the local macros START_BYTE() and > CHECK_FREQ_REG(). This prevents these kernel-doc warnings: > > ili922x.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * START_BYTE(id, rs, rw) > ili922x.c:85: warning: missing initial short description on line: > * START_BYTE(id, rs, rw) > ili922x.c:118: warning: expecting prototype for CHECK_FREQ_REG(spi_device s, spi_transfer x)(). Prototype was for CHECK_FREQ_REG() instead > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Lee Jones <lee@kernel.org> > Cc: Daniel Thompson <daniel.thompson@linaro.org> > Cc: Jingoo Han <jingoohan1@gmail.com> > Cc: Helge Deller <deller@gmx.de> > Cc: linux-fbdev@vger.kernel.org Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org> Daniel.
On Wed, 06 Dec 2023 09:45:25 -0800, Randy Dunlap wrote: > Don't use kernel-doc notation for the local macros START_BYTE() and > CHECK_FREQ_REG(). This prevents these kernel-doc warnings: > > ili922x.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > * START_BYTE(id, rs, rw) > ili922x.c:85: warning: missing initial short description on line: > * START_BYTE(id, rs, rw) > ili922x.c:118: warning: expecting prototype for CHECK_FREQ_REG(spi_device s, spi_transfer x)(). Prototype was for CHECK_FREQ_REG() instead > > [...] Applied, thanks! [1/1] backlight: ili922x: drop kernel-doc for local macros commit: 64d9799d6dd04601227f602ae961e3f3d2f1f02b -- Lee Jones [李琼斯]
diff -- a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c --- a/drivers/video/backlight/ili922x.c +++ b/drivers/video/backlight/ili922x.c @@ -81,7 +81,7 @@ #define START_RW_WRITE 0 #define START_RW_READ 1 -/** +/* * START_BYTE(id, rs, rw) * * Set the start byte according to the required operation. @@ -100,7 +100,7 @@ #define START_BYTE(id, rs, rw) \ (0x70 | (((id) & 0x01) << 2) | (((rs) & 0x01) << 1) | ((rw) & 0x01)) -/** +/* * CHECK_FREQ_REG(spi_device s, spi_transfer x) - Check the frequency * for the SPI transfer. According to the datasheet, the controller * accept higher frequency for the GRAM transfer, but it requires
Don't use kernel-doc notation for the local macros START_BYTE() and CHECK_FREQ_REG(). This prevents these kernel-doc warnings: ili922x.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * START_BYTE(id, rs, rw) ili922x.c:85: warning: missing initial short description on line: * START_BYTE(id, rs, rw) ili922x.c:118: warning: expecting prototype for CHECK_FREQ_REG(spi_device s, spi_transfer x)(). Prototype was for CHECK_FREQ_REG() instead Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Lee Jones <lee@kernel.org> Cc: Daniel Thompson <daniel.thompson@linaro.org> Cc: Jingoo Han <jingoohan1@gmail.com> Cc: Helge Deller <deller@gmx.de> Cc: linux-fbdev@vger.kernel.org --- v2: just drop the kernel-docness completely for these macros (Lee) drivers/video/backlight/ili922x.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)