2024-03-28 04:55:23

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] pwm: add missing kernel-doc for pwm_chip:cdev

Add a kernel-doc description of @cdev to prevent a build warning:

include/linux/pwm.h:308: warning: Function parameter or struct member 'cdev' not described in 'pwm_chip'

Signed-off-by: Randy Dunlap <[email protected]>
---
Cc: Uwe Kleine-König <[email protected]>
Cc: [email protected]

include/linux/pwm.h | 1 +
1 file changed, 1 insertion(+)

diff -- a/include/linux/pwm.h b/include/linux/pwm.h
--- a/include/linux/pwm.h
+++ b/include/linux/pwm.h
@@ -268,6 +268,7 @@ struct pwm_ops {
/**
* struct pwm_chip - abstract a PWM controller
* @dev: device providing the PWMs
+ * @cdev: &struct cdev for this device
* @ops: callbacks for this PWM controller
* @owner: module providing this chip
* @id: unique number of this PWM chip


2024-03-28 12:17:08

by Uwe Kleine-König

[permalink] [raw]
Subject: Re: [PATCH] pwm: add missing kernel-doc for pwm_chip:cdev

Hello Randy,

On Wed, Mar 27, 2024 at 09:55:13PM -0700, Randy Dunlap wrote:
> Add a kernel-doc description of @cdev to prevent a build warning:
>
> include/linux/pwm.h:308: warning: Function parameter or struct member 'cdev' not described in 'pwm_chip'
>
> Signed-off-by: Randy Dunlap <[email protected]>

Thanks for the fix, I applied it to my for-next branch at
https://git.kernel.org/pub/scm/linux/kernel/git/ukleinek/linux.git pwm/for-next
.

Best regards
Uwe

--
Pengutronix e.K. | Uwe Kleine-K?nig |
Industrial Linux Solutions | https://www.pengutronix.de/ |


Attachments:
(No filename) (644.00 B)
signature.asc (499.00 B)
Download all attachments