Received-SPF: pass (google.com: domain of linux-kernel+bounces-9174-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Message-ID: <40285311-8adc-4ca9-86ce-27c8b723a102@infradead.org>
Date: Thu, 21 Dec 2023 15:19:01 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH 1/1] hwmon: clarify intent of fan min/max
Content-Language: en-US
To: Ivor Wanders <ivor@iwanders.net>, Jean Delvare <jdelvare@suse.com>,
 Guenter Roeck <linux@roeck-us.net>, Jonathan Corbet <corbet@lwn.net>
Cc: linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org, Maximilian Luz <luzmaximilian@gmail.com>
References: <20231221225149.11295-1-ivor@iwanders.net>
 <20231221225149.11295-2-ivor@iwanders.net>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20231221225149.11295-2-ivor@iwanders.net>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

Hi,

On 12/21/23 14:51, Ivor Wanders wrote:
> This adds a link to the hwmon sysfs attributes in the hwmon patch
> submission bullet points. It also adds an explanation denoting the
> intent of the fan min and max attributes.
> 
> Signed-off-by: Ivor Wanders <ivor@iwanders.net>
> ---
>  Documentation/hwmon/submitting-patches.rst |  4 +++-
>  Documentation/hwmon/sysfs-interface.rst    | 12 +++++++++---
>  2 files changed, 12 insertions(+), 4 deletions(-)
> 


> diff --git a/Documentation/hwmon/sysfs-interface.rst b/Documentation/hwmon/sysfs-interface.rst
> index f76e9f8cc..72dd5e02d 100644
> --- a/Documentation/hwmon/sysfs-interface.rst
> +++ b/Documentation/hwmon/sysfs-interface.rst
> @@ -167,13 +167,19 @@ Fans
>  ****
>  
>  `fan[1-*]_min`
> -		Fan minimum value
> +		Fan minimum value, this is intended as a way to specify

Please change the comma here to either (a) semi-colon (';') or
(b) a period ('.') followed by a sentence beginning with a capital letter.

Same for the other 2 below also.

> +		the desired minimum speed to the device if the device
> +		supports that. It is not intended for communicating
> +		a constant that denotes the lowest possible fan speed.
>  
>  `fan[1-*]_max`
> -		Fan maximum value
> +		Fan maximum value, this is intended as a way to specify
> +		the desired maximum speed to the device if the device
> +		supports that. It is not intended for communicating
> +		a constant that denotes the highest possible fan speed.
>  
>  `fan[1-*]_input`
> -		Fan input value.
> +		Fan input value, this is the fan's current speed.
>  
>  `fan[1-*]_div`
>  		Fan divisor.

thanks.
-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html