linux-kernel - Re: [PATCH] docs: power: clean up power_supply

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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20251014052743.7epupfxrymbq3eu6@lcpd911>
Date: Tue, 14 Oct 2025 10:57:43 +0530
From: Dhruva Gole <d-gole@...com>
To: Randy Dunlap <rdunlap@...radead.org>
CC: <linux-kernel@...r.kernel.org>, Sebastian Reichel <sre@...nel.org>,
        "Rafael J. Wysocki" <rafael@...nel.org>, Len Brown <lenb@...nel.org>,
        Pavel
 Machek <pavel@...nel.org>, Jonathan Corbet <corbet@....net>,
        <linux-doc@...r.kernel.org>, <linux-pm@...r.kernel.org>
Subject: Re: [PATCH] docs: power: clean up power_supply_class.rst

On Oct 13, 2025 at 20:16:15 -0700, Randy Dunlap wrote:
> Clean up grammar, punctuation, etc., in the power supply class
> documentation.
> 
> Add article adjectives where needed.
> Hyphenate some adjectives.
> Fix punctuation.
> Fix some verb usage (singular/plural).
> Fix run-on sentences.
> Add "is" in a few places.
> Change "QA" to "Q&A".
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
> Cc: Sebastian Reichel <sre@...nel.org>
> Cc: "Rafael J. Wysocki" <rafael@...nel.org>
> Cc: Len Brown <lenb@...nel.org>
> Cc: Pavel Machek <pavel@...nel.org>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> Cc: linux-pm@...r.kernel.org
> ---
>  Documentation/power/power_supply_class.rst |   84 +++++++++----------
>  1 file changed, 42 insertions(+), 42 deletions(-)
> 
> --- linux-next-20251013.orig/Documentation/power/power_supply_class.rst
> +++ linux-next-20251013/Documentation/power/power_supply_class.rst
> @@ -7,35 +7,35 @@ Synopsis
>  Power supply class used to represent battery, UPS, AC or DC power supply
>  properties to user-space.
>  
> -It defines core set of attributes, which should be applicable to (almost)
> +It defines a core set of attributes which should be applicable to (almost)
>  every power supply out there. Attributes are available via sysfs and uevent
>  interfaces.
>  
> -Each attribute has well defined meaning, up to unit of measure used. While
> +Each attribute has a well-defined meaning, up to unit of measure used. While

Not a native English speaker but see if this makes sense?
up to "the" unit of measure used.

>  the attributes provided are believed to be universally applicable to any
>  power supply, specific monitoring hardware may not be able to provide them
>  all, so any of them may be skipped.
>  
> -Power supply class is extensible, and allows to define drivers own attributes.
> -The core attribute set is subject to the standard Linux evolution (i.e.
> -if it will be found that some attribute is applicable to many power supply
> -types or their drivers, it can be added to the core set).
> +The power supply class is extensible and allows drivers to define their own
> +attributes.  The core attribute set is subject to the standard Linux evolution
> +(i.e., if it will be found that some attribute is applicable to many power

Reword as follows:
i.e., if some attribute is found to be applicable to many power supply types

> +supply types or their drivers, it can be added to the core set).
>  
> -It also integrates with LED framework, for the purpose of providing
> +It also integrates with the LED framework, for the purpose of providing
>  typically expected feedback of battery charging/fully charged status and
>  AC/USB power supply online status. (Note that specific details of the
>  indication (including whether to use it at all) are fully controllable by
> -user and/or specific machine defaults, per design principles of LED
> -framework).
> +user and/or specific machine defaults, per design principles of the LED
> +framework.)
>  

With that, if you plan to respin feel free to include:
Reviewed-by: Dhruva Gole <d-gole@...com>

-- 
Best regards,
Dhruva Gole
Texas Instruments Incorporated