Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Sender: james@equiv.tech
Date:   Fri, 5 May 2023 08:01:09 -0700
From:   James Seo <james@equiv.tech>
To:     Bagas Sanjaya <bagasdotme@gmail.com>
Cc:     James Seo <james@equiv.tech>, Jean Delvare <jdelvare@suse.com>,
        Guenter Roeck <linux@roeck-us.net>,
        Jonathan Corbet <corbet@lwn.net>, linux-hwmon@vger.kernel.org,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [RFC 07/11] Documentation/hwmon: Revise sysfs interface
 specification
Message-ID: <ZFUaNQAxjvnFnsOr@equiv.tech>
References: <20230504075752.1320967-1-james@equiv.tech>
 <20230504075752.1320967-8-james@equiv.tech>
 <ZFSLN6KmGgfW4YzE@debian.me>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <ZFSLN6KmGgfW4YzE@debian.me>
Precedence: bulk

On Fri, May 05, 2023 at 11:51:03AM +0700, Bagas Sanjaya wrote:
> On Thu, May 04, 2023 at 12:57:48AM -0700, James Seo wrote:
>> +**RO**    Read-only value.
>> +**WO**    Write-only value.
>> +**RW**    Read/write value.
> 
> Why are the permissions be emphasized?

I don't remember, to be honest. I will deemphasize permissions.

> 
>> +| | ``pwm[1-*]_auto_point[1-*]_pwm``        | **RW** | PWM temperature curve definition    |
>> +| | ``pwm[1-*]_auto_point[1-*]_temp``       |        | for chips that associate trip       |
>> +| | ``pwm[1-*]_auto_point[1-*]_temp_hyst``  |        | points with PWM output channels.    |
>> ++-------------------------------------------+--------+-------------------------------------+
>> +| | ``temp[1-*]_auto_point[1-*]_pwm``       | **RW** | PWM temperature curve definition    |
>> +| | ``temp[1-*]_auto_point[1-*]_temp``      |        | for chips that associate trip       |
>> +| | ``temp[1-*]_auto_point[1-*]_temp_hyst`` |        | points with temperature channels.   |
> 
> Dunno if replacing line blocks with bullet lists should improve the semantic
> of three sysfs files having the same description.
> 
> Thanks.
> 
> -- 
> An old man doll... just what I always wanted! - Clara

These are line blocks, not bullet lists. They ensure that each
attribute name is on its own line, avoiding strange wrapping like:

  pwm[1-*]_auto_point[1-*]_pwm pwm[1-*]_auto
  _point[1-*]_temp pwm[1-*]_auto_point[1-*]_temp_hyst