[PATCH] docs: hwmon: (lm75) Add section for sysfs interface

[PATCH] docs: hwmon: (lm75) Add section for sysfs interface

[Flaviu Nistor]

Similar to other HWMON sensors add a section in the
documentation describing the sysfs attributes, their
permissions and a short description.

Signed-off-by: Flaviu Nistor <flaviu.nistor@gmail.com>
---
 Documentation/hwmon/lm75.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/Documentation/hwmon/lm75.rst b/Documentation/hwmon/lm75.rst
index 4269da04508e..288cf8485ea6 100644
--- a/Documentation/hwmon/lm75.rst
+++ b/Documentation/hwmon/lm75.rst
@@ -181,3 +181,19 @@ is supported by this driver, other specific enhancements are not.
 
 The LM77 is not supported, contrary to what we pretended for a long time.
 Both chips are simply not compatible, value encoding differs.
+
+sysfs-Interface
+---------------
+
+The following list includes the sysfs attributes that the driver provides, their
+permissions and a short description:
+
+=============================== ======= ===========================================
+Name                            Perm    Description
+=============================== ======= ===========================================
+temp1_input:                    RO      Temperature input
+temp1_label:                    RO      Descriptive name for the sensor
+temp1_max:                      RW      Maximum temperature
+temp1_max_hyst:                 RW      Maximum hysteresis temperature
+update_interval                 RW      Update conversions interval in milliseconds
+=============================== ======= ===========================================
-- 
2.34.1

Re: [PATCH] docs: hwmon: (lm75) Add section for sysfs interface

[sashiko-bot]

Sashiko AI review found 3 potential issue(s):
- [Low] Missing `temp1_alarm` sysfs attribute in the documentation.
- [Low] Inaccurate permissions documented for `update_interval`.
- [Low] Extraneous trailing colons in sysfs attribute names.
--

commit c1dce0b929df71ecb8a78067d9800bb8e1c93d8f
Author: Flaviu Nistor <flaviu.nistor@gmail.com>

docs: hwmon: (lm75) Add section for sysfs interface

This commit adds a new section to the lm75 documentation detailing the
sysfs attributes, their permissions, and brief descriptions.

> diff --git a/Documentation/hwmon/lm75.rst b/Documentation/hwmon/lm75.rst
> index 4269da04508ef..288cf8485ea61 100644
> --- a/Documentation/hwmon/lm75.rst
> +++ b/Documentation/hwmon/lm75.rst

[ ... ]

> +sysfs-Interface
> +---------------
> +
> +The following list includes the sysfs attributes that the driver provides, their
> +permissions and a short description:
> +
> +=============================== ======= ===========================================
> +Name                            Perm    Description
> +=============================== ======= ===========================================
> +temp1_input:                    RO      Temperature input
> +temp1_label:                    RO      Descriptive name for the sensor
> +temp1_max:                      RW      Maximum temperature
> +temp1_max_hyst:                 RW      Maximum hysteresis temperature

This isn't a bug, but should the trailing colons on these attribute names
be removed? Sysfs filenames do not contain colons, and the update_interval
attribute below correctly omits it.

> +update_interval                 RW      Update conversions interval in milliseconds

Is update_interval always read/write? Looking at lm75_is_visible() in the
driver, it appears to only grant write permissions (0644) if the device
supports multiple sample times. For chips with a single fixed sample time,
the attribute is restricted to read-only (0444). Could the documentation
reflect this conditional permission?

> +=============================== ======= ===========================================

Should temp1_alarm be included in this list? The driver code exposes
HWMON_T_ALARM as read-only for chips that support it (such as the as6200
and tmp112), so the current documentation seems slightly incomplete without
it.

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260417054511.5432-1-flaviu.nistor@gmail.com?part=1