diff mbox series

pwm: linux/pwm.h: fix Excess kernel-doc description warning

Message ID 20231223050621.13994-1-rdunlap@infradead.org
State New
Headers
Series pwm: linux/pwm.h: fix Excess kernel-doc description warning |

Commit Message

Randy Dunlap Dec. 23, 2023, 5:06 a.m. UTC 
  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 <rdunlap@infradead.org>
Cc: Thierry Reding <thierry.reding@gmail.com>
Cc: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Cc: linux-pwm@vger.kernel.org
---
 include/linux/pwm.h |    1 -
 1 file changed, 1 deletion(-)

Comments

Uwe Kleine-König Dec. 23, 2023, 11:29 p.m. UTC | #1 
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 <rdunlap@infradead.org>
> Cc: Thierry Reding <thierry.reding@gmail.com>
> Cc: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> Cc: linux-pwm@vger.kernel.org

Oh indeed.

Fixes: f3e25e68ceb2 ("pwm: Drop unused member "pwm" from struct pwm_device")
Reviewed-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>

Thanks
Uwe
Thierry Reding Jan. 5, 2024, 8:32 a.m. UTC | #2 
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,
diff mbox series

Patch

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