2023-12-23 05:08:20

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] pwm: linux/pwm.h: fix Excess kernel-doc description warning

Remove the @pwm: line to prevent the kernel-doc warning:

include/linux/pwm.h:87: warning: Excess struct member 'pwm' description in 'pwm_device'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Thierry Reding <[email protected]>
Cc: Uwe Kleine-König <[email protected]>
Cc: [email protected]
---
include/linux/pwm.h | 1 -
1 file changed, 1 deletion(-)

diff -- a/include/linux/pwm.h b/include/linux/pwm.h
--- a/include/linux/pwm.h
+++ b/include/linux/pwm.h
@@ -69,7 +69,6 @@ struct pwm_state {
* @label: name of the PWM device
* @flags: flags associated with the PWM device
* @hwpwm: per-chip relative index of the PWM device
- * @pwm: global index of the PWM device
* @chip: PWM chip providing this PWM device
* @args: PWM arguments
* @state: last applied state


2023-12-23 23:30:21

by Uwe Kleine-König

[permalink] [raw]
Subject: Re: [PATCH] pwm: linux/pwm.h: fix Excess kernel-doc description warning

Hello Randy,

On Fri, Dec 22, 2023 at 09:06:20PM -0800, Randy Dunlap wrote:
> Remove the @pwm: line to prevent the kernel-doc warning:
>
> include/linux/pwm.h:87: warning: Excess struct member 'pwm' description in 'pwm_device'
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Thierry Reding <[email protected]>
> Cc: Uwe Kleine-K?nig <[email protected]>
> Cc: [email protected]

Oh indeed.

Fixes: f3e25e68ceb2 ("pwm: Drop unused member "pwm" from struct pwm_device")
Reviewed-by: Uwe Kleine-K?nig <[email protected]>

Thanks
Uwe

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


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

2024-01-05 08:33:04

by Thierry Reding

[permalink] [raw]
Subject: Re: [PATCH] pwm: linux/pwm.h: fix Excess kernel-doc description warning


On Fri, 22 Dec 2023 21:06:20 -0800, Randy Dunlap wrote:
> Remove the @pwm: line to prevent the kernel-doc warning:
>
> include/linux/pwm.h:87: warning: Excess struct member 'pwm' description in 'pwm_device'
>
>

Applied, thanks!

[1/1] pwm: linux/pwm.h: fix Excess kernel-doc description warning
commit: 2c396fceac256ee30f7f45b24d2e3bb64f0c9294

Best regards,
--
Thierry Reding <[email protected]>