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
Date: Fri, 5 May 2023 08:01:09 -0700 [thread overview]
Message-ID: <ZFUaNQAxjvnFnsOr@equiv.tech> (raw)
In-Reply-To: <ZFSLN6KmGgfW4YzE@debian.me>
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
next prev parent reply other threads:[~2023-05-05 15:01 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-04 7:57 [RFC 00/11] hwmon: Modernize documentation James Seo
2023-05-04 7:57 ` [RFC 01/11] Documentation/hwmon: Move misplaced entry in hwmon docs index James Seo
2023-05-05 4:58 ` Bagas Sanjaya
2023-05-06 13:43 ` Guenter Roeck
2023-05-04 7:57 ` [RFC 02/11] hwmon: (core) Rename last parameter of devm_hwmon_register_with_info() James Seo
2023-05-04 15:29 ` Guenter Roeck
2023-05-05 13:15 ` James Seo
2023-05-05 13:30 ` Guenter Roeck
2023-05-05 14:39 ` James Seo
2023-05-04 7:57 ` [RFC 03/11] hwmon: (core) Revise kerneldoc comments James Seo
2023-07-25 23:51 ` Russell Haley
2023-05-04 7:57 ` [RFC 04/11] Documentation/hwmon: Revise hwmon kernel API reference James Seo
2023-05-05 4:12 ` Bagas Sanjaya
2023-05-05 4:20 ` Bagas Sanjaya
2023-05-05 13:29 ` James Seo
2023-05-06 13:52 ` Guenter Roeck
2023-05-07 14:40 ` James Seo
2023-05-04 7:57 ` [RFC 05/11] Documentation/hwmon: Revise PMBus core documentation James Seo
2023-05-05 4:27 ` Bagas Sanjaya
2023-05-05 4:32 ` Guenter Roeck
2023-05-05 13:35 ` James Seo
2023-05-04 7:57 ` [RFC 06/11] Documentation/hwmon: Revise patch submission checklist James Seo
2023-05-05 4:34 ` Bagas Sanjaya
2023-05-05 14:50 ` James Seo
2023-05-04 7:57 ` [RFC 07/11] Documentation/hwmon: Revise sysfs interface specification James Seo
2023-05-05 4:51 ` Bagas Sanjaya
2023-05-05 15:01 ` James Seo [this message]
2023-05-05 15:10 ` Jonathan Corbet
2023-05-04 7:57 ` [RFC 08/11] Documentation/hwmon: Revise userspace tools documentation James Seo
2023-05-05 5:03 ` Bagas Sanjaya
2023-05-05 15:12 ` James Seo
2023-05-05 21:10 ` Guenter Roeck
2023-05-04 7:57 ` [RFC 09/11] ABI: sysfs-class-hwmon: Revise hwmon ABI documentation James Seo
2023-05-04 7:57 ` [RFC 10/11] hwmon: (core) Add missing beep-related standard attributes James Seo
2023-05-04 7:57 ` [RFC 11/11] ABI: sysfs-class-hwmon: Add missing hwmon " James Seo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZFUaNQAxjvnFnsOr@equiv.tech \
--to=james@equiv.tech \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.