[0/1] clarify intent of fan min and max attributes

Message

Ivor Wanders Dec. 21, 2023, 10:51 p.m. UTC

In [1] I got the feedback that fan min and max attributes are intended for
writing to the device and not merely providing constants to userspace.
This patch clarifies this intent in the documentation such that future
contributers don't make incorrect assumptions about them.

[1]: https://lore.kernel.org/linux-hwmon/[e-mail]/

Ivor Wanders (1):
  hwmon: clarify intent of fan min/max

 Documentation/hwmon/submitting-patches.rst |  4 +++-
 Documentation/hwmon/sysfs-interface.rst    | 12 +++++++++---
 2 files changed, 12 insertions(+), 4 deletions(-)

Comments

Guenter Roeck Dec. 22, 2023, 4:12 p.m. UTC | #1

On Thu, Dec 21, 2023 at 05:51:48PM -0500, Ivor Wanders wrote:
> In [1] I got the feedback that fan min and max attributes are intended for
> writing to the device and not merely providing constants to userspace.
> This patch clarifies this intent in the documentation such that future
> contributers don't make incorrect assumptions about them.
> 

Documentation/hwmon/sysfs-interface already states:

"
All entries (except name) are optional, and should only be created in a
given driver if the chip has the feature.
"

I do not see the point of clarifying this for individual attributes,
especially since that might create the impression that it would possibly
not apply to other attributes (for those not reading the above
documentation).

Guenter

Ivor Wanders Dec. 22, 2023, 11:17 p.m. UTC | #2

> I do not see the point of clarifying this for individual attributes,
> especially since that might create the impression that it would possibly
> not apply to other attributes (for those not reading the above
> documentation).

Okay, fair point, I can see that lead to more confusion indeed.

~Ivor