2023-03-12 15:58:24

by Stefan Wahren

[permalink] [raw]
Subject: [PATCH] docs: hwmon: sysfs-interface: Fix stray colon

The commit 036d6a4e75c9 ("ABI: sysfs-class-hwmon: add ABI documentation
for it") moved all ABI attributes to the usual ABI documentation. But this
change left a stray colon for the fan speed control method. Fix this
to avoid a confusion of readers.

Fixes: 036d6a4e75c9 ("ABI: sysfs-class-hwmon: add ABI documentation for it")
Signed-off-by: Stefan Wahren <[email protected]>
---
Documentation/hwmon/sysfs-interface.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/hwmon/sysfs-interface.rst b/Documentation/hwmon/sysfs-interface.rst
index 209626fb2405..f76e9f8cc1ad 100644
--- a/Documentation/hwmon/sysfs-interface.rst
+++ b/Documentation/hwmon/sysfs-interface.rst
@@ -201,7 +201,7 @@ PWM
Pulse width modulation fan control.

`pwm[1-*]_enable`
- Fan speed control method:
+ Fan speed control method.

`pwm[1-*]_mode`
direct current or pulse-width modulation.
--
2.34.1



2023-03-12 18:23:15

by Guenter Roeck

[permalink] [raw]
Subject: Re: [PATCH] docs: hwmon: sysfs-interface: Fix stray colon

On Sun, Mar 12, 2023 at 04:57:14PM +0100, Stefan Wahren wrote:
> The commit 036d6a4e75c9 ("ABI: sysfs-class-hwmon: add ABI documentation
> for it") moved all ABI attributes to the usual ABI documentation. But this
> change left a stray colon for the fan speed control method. Fix this
> to avoid a confusion of readers.
>
> Fixes: 036d6a4e75c9 ("ABI: sysfs-class-hwmon: add ABI documentation for it")
> Signed-off-by: Stefan Wahren <[email protected]>

Applied.

Thanks,
Guenter

> ---
> Documentation/hwmon/sysfs-interface.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/hwmon/sysfs-interface.rst b/Documentation/hwmon/sysfs-interface.rst
> index 209626fb2405..f76e9f8cc1ad 100644
> --- a/Documentation/hwmon/sysfs-interface.rst
> +++ b/Documentation/hwmon/sysfs-interface.rst
> @@ -201,7 +201,7 @@ PWM
> Pulse width modulation fan control.
>
> `pwm[1-*]_enable`
> - Fan speed control method:
> + Fan speed control method.
>
> `pwm[1-*]_mode`
> direct current or pulse-width modulation.