linux-kernel - Re: [PATCH v18 3/3] docs: leds: Document TI LP5812 LED driver

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 for Android: free password hash cracker in your pocket

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

Message-ID: <2392c2c1-1367-40ed-81df-f8114a247cd8@infradead.org>
Date: Sun, 23 Nov 2025 11:20:19 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Nam Tran <trannamatk@...il.com>, lee@...nel.org
Cc: pavel@...nel.org, gregkh@...uxfoundation.org,
 christophe.jaillet@...adoo.fr, krzk+dt@...nel.org, robh@...nel.org,
 conor+dt@...nel.org, corbet@....net, linux-leds@...r.kernel.org,
 linux-kernel@...r.kernel.org, devicetree@...r.kernel.org,
 linux-doc@...r.kernel.org
Subject: Re: [PATCH v18 3/3] docs: leds: Document TI LP5812 LED driver

Hi,

On 11/23/25 11:10 AM, Nam Tran wrote:
> The driver provides sysfs interfaces to control and configure the
> LP5812 device and its LED channels.
> 
> The documetation describes the chip's capabilities, sysfs interface,
> and usage examples.
> 
> Signed-off-by: Nam Tran <trannamatk@...il.com>
> ---
>  Documentation/leds/index.rst       |  1 +
>  Documentation/leds/leds-lp5812.rst | 50 ++++++++++++++++++++++++++++++
>  MAINTAINERS                        |  1 +
>  3 files changed, 52 insertions(+)
>  create mode 100644 Documentation/leds/leds-lp5812.rst
> 

> diff --git a/Documentation/leds/leds-lp5812.rst b/Documentation/leds/leds-lp5812.rst
> new file mode 100644
> index 000000000000..4c22d9a79d14
> --- /dev/null
> +++ b/Documentation/leds/leds-lp5812.rst
> @@ -0,0 +1,50 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +========================
> +Kernel driver for lp5812
> +========================
> +
> +* TI/National Semiconductor LP5812 LED Driver
> +* Datasheet: https://www.ti.com/product/LP5812#tech-docs
> +
> +Authors: Jared Zhou <jared-zhou@...com>
> +
> +Description
> +===========
> +
> +The LP5812 is a 4x3 matrix LED driver with support for both manual and
> +autonomous animation control. This driver provides sysfs interfaces to
> +control and configure the LP5812 device and its LED channels.
> +
> +Sysfs Interface
> +===============
> +
> +This driver uses the standard multicolor LED class interfaces defined
> +in `Documentation/ABI/testing/sysfs-class-led-multicolor`.

If you will remove the ` quote marks and add .rst to the filename,
the kdoc system will create a link to that other document.
This is the preferred method.

> +
> +Each LP5812 LED output appears under ``/sys/class/leds/`` with its
> +assigned label (for example ``LED_A``).
> +
> +The following attributes are exposed:
> +  - multi_intensity: Per-channel RGB intensity control.
> +  - brightness: Standard brightness control (0-255)

The 2 lines above should both end with '.' or not end with '.'
(be consistent). They are not sentences so IMO no ending
'.' is needed.

-- 
~Randy