linux-kernel - [PATCH] leds: lm3692x: fix kernel-doc for struct lm3692x

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20251201042612.2099239-1-vivek.balachandhar@gmail.com>
Date: Mon,  1 Dec 2025 04:26:12 +0000
From: Vivek BalachandharTN <vivek.balachandhar@...il.com>
To: Lee Jones <lee@...nel.org>,
	Pavel Machek <pavel@...nel.org>
Cc: linux-leds@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Vivek Balachandhar TN <vivek.balachandhar@...il.com>
Subject: [PATCH] leds: lm3692x: fix kernel-doc for struct lm3692x_led

Building with W=1 reports several kernel-doc warnings in
drivers/leds/leds-lm3692x.c:

  Warning: leds-lm3692x.c:122 struct member 'boost_ctrl'
  not described in 'lm3692x_led'
  Warning: leds-lm3692x.c:122 struct member 'brightness_ctrl'
  not described in 'lm3692x_led'
  Warning: leds-lm3692x.c:122 struct member 'enabled'
  not described in 'lm3692x_led'

These fields were added to struct lm3692x_led but the corresponding
kernel-doc comment was not updated. Convert the kernel-doc block to
use the "@member: description" style consistently and document the
boost_ctrl, brightness_ctrl and enabled fields.

This keeps the documentation in sync with the implementation and
silences the W=1 warnings.

Signed-off-by: Vivek BalachandharTN <vivek.balachandhar@...il.com>
---
 drivers/leds/leds-lm3692x.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/leds/leds-lm3692x.c b/drivers/leds/leds-lm3692x.c
index c319ff4d70b2..1d64ceb5ac85 100644
--- a/drivers/leds/leds-lm3692x.c
+++ b/drivers/leds/leds-lm3692x.c
@@ -104,6 +104,9 @@
  * @regulator: LED supply regulator pointer
  * @led_enable: LED sync to be enabled
  * @model_id: Current device model ID enumerated
+ * @boost_ctrl: Cached configuration for the boost control register
+ * @brightness_ctrl: Cached configuration for brightness/brightness control
+ * @enabled: Cached enable state of the device
  */
 struct lm3692x_led {
 	struct mutex lock;
-- 
2.34.1