leds: fix 3 drivers' kernel-doc warnings
Subsystems (2)
PATCH 1/1 leds: fix 3 drivers' kernel-doc warnings
Fix kernel-doc warnings in 3 leds drivers:
[PATCH v2 1/3] leds: lm3601x: fix struct lm3601_led kernel-doc warnings [PATCH v2 2/3] leds: leds-mlxcpld: fix struct mlxcpld_led_priv member name [PATCH v2 3/3] leds: mlxreg: drop an excess struct mlxreg_led_data member
drivers/leds/flash/leds-lm3601x.c | 3 +-- drivers/leds/leds-mlxcpld.c | 2 +- drivers/leds/leds-mlxreg.c | 1 - 3 files changed, 2 insertions(+), 4 deletions(-)
PATCH v2 1/3 leds: lm3601x: fix struct lm3601_led kernel-doc warnings
Add a short struct description and remove one extraneous struct field description to quieten these warnings:
leds-lm3601x.c:73: warning: missing initial short description on line:
* struct lm3601x_led -
leds-lm3601x.c:100: warning: Excess struct member 'led_name' description in 'lm3601x_led'
---
v2: make the 3 leds patches a series as requested by Lee;
make the Subject better/unique
drivers/leds/flash/leds-lm3601x.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
drivers/leds/flash/leds-lm3601x.c +1 -2
@@ -70,12 +70,11 @@ enum lm3601x_type { };/** -* struct lm3601x_led - +* struct lm3601x_led - private lm3601x LED data * @fled_cdev: flash LED class device pointer * @client: Pointer to the I2C client * @regmap: Devices register map * @lock: Lock for reading/writing the device -* @led_name: LED label for the Torch or IR LED * @flash_timeout: the timeout for the flash * @last_flag: last known flags register value * @torch_current_max: maximum current for the torch
PATCH v2 2/3 leds: leds-mlxcpld: fix struct mlxcpld_led_priv member name
In reply to Randy DunlapChange "cled" to "cdev" to quieten kernel-doc warnings:
leds-mlxcpld.c:86: warning: Function parameter or struct member 'cdev' not described in 'mlxcpld_led_priv' leds-mlxcpld.c:86: warning: Excess struct member 'cled' description in 'mlxcpld_led_priv'
---
v2: make the 3 leds patches a series as requested by Lee;
make the Subject better/unique
drivers/leds/leds-mlxcpld.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/leds/leds-mlxcpld.c +1 -1
@@ -77,7 +77,7 @@ struct mlxcpld_param {/** * struct mlxcpld_led_priv - LED private data: -* @cled: LED class device instance +* @cdev: LED class device instance * @param: LED CPLD access parameters **/ struct mlxcpld_led_priv {
PATCH v2 3/3 leds: mlxreg: drop an excess struct mlxreg_led_data member
In reply to Randy DunlapDrop one struct member description to fix a kernel-doc warning:
drivers/leds/leds-mlxreg.c:42: warning: Excess struct member 'led_data' description in 'mlxreg_led_data'
---
v2: make the 3 leds patches a series as requested by Lee;
make the Subject better/unique
drivers/leds/leds-mlxreg.c | 1 - 1 file changed, 1 deletion(-)
drivers/leds/leds-mlxreg.c +0 -1
@@ -29,7 +29,6 @@* @data: led configuration data; * @led_cdev: led class data; * @base_color: base led color (other colors have constant offset from base); -* @led_data: led data; * @data_parent: pointer to private device control data of parent; * @led_cdev_name: class device name */
Quoted 22 lines
-----Original Message-----
From: Randy Dunlap <[email protected]>
Sent: Thursday, 29 February 2024 9:19
To: [email protected]
Cc: Randy Dunlap <[email protected]>; Pavel Machek <[email protected]>; Lee Jones <[email protected]>; [email protected]; Vadim Pasternak <[email protected]>
Subject: [PATCH] leds: fix 3 drivers' kernel-doc warningsFix kernel-doc warnings in 3 leds drivers:
[PATCH v2 1/3] leds: lm3601x: fix struct
lm3601_ledkernel-doc warnings
[PATCH v2 2/3] leds: leds-mlxcpld: fix structmlxcpld_led_privmember name [PATCH v2 3/3] leds: mlxreg: drop an excess structmlxreg_led_datamemberdrivers/leds/flash/leds-lm3601x.c | 3 +-- drivers/leds/leds-mlxcpld.c | 2 +- drivers/leds/leds-mlxreg.c | 1 - 3 files changed, 2 insertions(+), 4 deletions(-)
Quoted 4 lines
Cc Pavel Machek <[email protected]>Cc Lee Jones <[email protected]>Cc Vadim Pasternak <[email protected]>
Quoted 6 lines · Randy Dunlap
Fix kernel-doc warnings in 3 leds drivers:
[PATCH v2 1/3] leds: lm3601x: fix struct
lm3601_ledkernel-doc warnings [PATCH v2 2/3] leds: leds-mlxcpld: fix structmlxcpld_led_privmember name [PATCH v2 3/3] leds: mlxreg: drop an excess structmlxreg_led_datamember
Quoted 6 lines
drivers/leds/flash/leds-lm3601x.c | 3 +-- drivers/leds/leds-mlxcpld.c | 2 +- drivers/leds/leds-mlxreg.c | 1 - 3 files changed, 2 insertions(+), 4 deletions(-)[...]
Applied, thanks!
[1/3] leds: lm3601x: fix struct lm3601_led kernel-doc warnings
commit: 5edfca391c5fb2fa12c438aee5ccbe0b22713f31
[2/3] leds: leds-mlxcpld: fix struct mlxcpld_led_priv member name
commit: 0e225365753c8824b720588252458be87a0841a1
[3/3] leds: mlxreg: drop an excess struct mlxreg_led_data member
commit: 5764ba63b4256008d59d178dfbec9851cf9a7b92--
Lee Jones [李琼斯]