* [PATCH] ABI: sysfs-driver-mlxreg-io: fix the what fields
@ 2019-06-21 9:54 Mauro Carvalho Chehab
2019-06-21 10:33 ` Andy Shevchenko
0 siblings, 1 reply; 2+ messages in thread
From: Mauro Carvalho Chehab @ 2019-06-21 9:54 UTC (permalink / raw)
To: Linux Doc Mailing List, Greg Kroah-Hartman
Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Darren Hart (VMware),
Vadim Pasternak, Andy Shevchenko
The author of this file should be given an award for creativity:
the What: fields on this file technically fulfills the description
at README. Yet, the way it is, it can't be parsed on a script,
and if someone would try to do something like:
grep hwmon*/jtag_enable
It wouldn't find anything.
Fix the What fields in a way that it can be parseable by a
script and other search tools.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
.../ABI/stable/sysfs-driver-mlxreg-io | 45 ++++++++-----------
1 file changed, 19 insertions(+), 26 deletions(-)
diff --git a/Documentation/ABI/stable/sysfs-driver-mlxreg-io b/Documentation/ABI/stable/sysfs-driver-mlxreg-io
index 156319fc5b80..3544968f43cc 100644
--- a/Documentation/ABI/stable/sysfs-driver-mlxreg-io
+++ b/Documentation/ABI/stable/sysfs-driver-mlxreg-io
@@ -1,5 +1,4 @@
-What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
- asic_health
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/asic_health
Date: June 2018
KernelVersion: 4.19
@@ -9,9 +8,8 @@ Description: This file shows ASIC health status. The possible values are:
The files are read only.
-What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
- cpld1_version
- cpld2_version
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld1_version
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld2_version
Date: June 2018
KernelVersion: 4.19
Contact: Vadim Pasternak <vadimpmellanox.com>
@@ -20,8 +18,7 @@ Description: These files show with which CPLD versions have been burned
The files are read only.
-What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
- fan_dir
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/fan_dir
Date: December 2018
KernelVersion: 5.0
@@ -32,8 +29,7 @@ Description: This file shows the system fans direction:
The files are read only.
-What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
- jtag_enable
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/jtag_enable
Date: November 2018
KernelVersion: 5.0
@@ -43,8 +39,7 @@ Description: These files show with which CPLD versions have been burned
The files are read only.
-What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
- jtag_enable
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/jtag_enable
Date: November 2018
KernelVersion: 5.0
@@ -87,16 +82,15 @@ Description: These files allow asserting system power cycling, switching
The files are write only.
-What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
- reset_aux_pwr_or_ref
- reset_asic_thermal
- reset_hotswap_or_halt
- reset_hotswap_or_wd
- reset_fw_reset
- reset_long_pb
- reset_main_pwr_fail
- reset_short_pb
- reset_sw_reset
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_aux_pwr_or_ref
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_asic_thermal
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_hotswap_or_halt
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_hotswap_or_wd
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_fw_reset
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_long_pb
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_main_pwr_fail
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_short_pb
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_sw_reset
Date: June 2018
KernelVersion: 4.19
Contact: Vadim Pasternak <vadimpmellanox.com>
@@ -110,11 +104,10 @@ Description: These files show the system reset cause, as following: power
The files are read only.
-What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
- reset_comex_pwr_fail
- reset_from_comex
- reset_system
- reset_voltmon_upgrade_fail
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_comex_pwr_fail
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_from_comex
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_system
+What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_voltmon_upgrade_fail
Date: November 2018
KernelVersion: 5.0
--
2.21.0
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] ABI: sysfs-driver-mlxreg-io: fix the what fields
2019-06-21 9:54 [PATCH] ABI: sysfs-driver-mlxreg-io: fix the what fields Mauro Carvalho Chehab
@ 2019-06-21 10:33 ` Andy Shevchenko
0 siblings, 0 replies; 2+ messages in thread
From: Andy Shevchenko @ 2019-06-21 10:33 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Greg Kroah-Hartman,
Mauro Carvalho Chehab, Linux Kernel Mailing List,
Jonathan Corbet, Darren Hart (VMware),
Vadim Pasternak
On Fri, Jun 21, 2019 at 12:54 PM Mauro Carvalho Chehab
<mchehab+samsung@kernel.org> wrote:
>
> The author of this file should be given an award for creativity:
> the What: fields on this file technically fulfills the description
> at README. Yet, the way it is, it can't be parsed on a script,
> and if someone would try to do something like:
>
> grep hwmon*/jtag_enable
>
> It wouldn't find anything.
>
> Fix the What fields in a way that it can be parseable by a
> script and other search tools.
>
Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Thanks, Mauro, for fixing this.
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
> .../ABI/stable/sysfs-driver-mlxreg-io | 45 ++++++++-----------
> 1 file changed, 19 insertions(+), 26 deletions(-)
>
> diff --git a/Documentation/ABI/stable/sysfs-driver-mlxreg-io b/Documentation/ABI/stable/sysfs-driver-mlxreg-io
> index 156319fc5b80..3544968f43cc 100644
> --- a/Documentation/ABI/stable/sysfs-driver-mlxreg-io
> +++ b/Documentation/ABI/stable/sysfs-driver-mlxreg-io
> @@ -1,5 +1,4 @@
> -What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
> - asic_health
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/asic_health
>
> Date: June 2018
> KernelVersion: 4.19
> @@ -9,9 +8,8 @@ Description: This file shows ASIC health status. The possible values are:
>
> The files are read only.
>
> -What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
> - cpld1_version
> - cpld2_version
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld1_version
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/cpld2_version
> Date: June 2018
> KernelVersion: 4.19
> Contact: Vadim Pasternak <vadimpmellanox.com>
> @@ -20,8 +18,7 @@ Description: These files show with which CPLD versions have been burned
>
> The files are read only.
>
> -What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
> - fan_dir
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/fan_dir
>
> Date: December 2018
> KernelVersion: 5.0
> @@ -32,8 +29,7 @@ Description: This file shows the system fans direction:
>
> The files are read only.
>
> -What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
> - jtag_enable
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/jtag_enable
>
> Date: November 2018
> KernelVersion: 5.0
> @@ -43,8 +39,7 @@ Description: These files show with which CPLD versions have been burned
>
> The files are read only.
>
> -What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
> - jtag_enable
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/jtag_enable
>
> Date: November 2018
> KernelVersion: 5.0
> @@ -87,16 +82,15 @@ Description: These files allow asserting system power cycling, switching
>
> The files are write only.
>
> -What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
> - reset_aux_pwr_or_ref
> - reset_asic_thermal
> - reset_hotswap_or_halt
> - reset_hotswap_or_wd
> - reset_fw_reset
> - reset_long_pb
> - reset_main_pwr_fail
> - reset_short_pb
> - reset_sw_reset
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_aux_pwr_or_ref
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_asic_thermal
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_hotswap_or_halt
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_hotswap_or_wd
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_fw_reset
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_long_pb
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_main_pwr_fail
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_short_pb
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_sw_reset
> Date: June 2018
> KernelVersion: 4.19
> Contact: Vadim Pasternak <vadimpmellanox.com>
> @@ -110,11 +104,10 @@ Description: These files show the system reset cause, as following: power
>
> The files are read only.
>
> -What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/
> - reset_comex_pwr_fail
> - reset_from_comex
> - reset_system
> - reset_voltmon_upgrade_fail
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_comex_pwr_fail
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_from_comex
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_system
> +What: /sys/devices/platform/mlxplat/mlxreg-io/hwmon/hwmon*/reset_voltmon_upgrade_fail
>
> Date: November 2018
> KernelVersion: 5.0
> --
> 2.21.0
>
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-06-21 10:33 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-06-21 9:54 [PATCH] ABI: sysfs-driver-mlxreg-io: fix the what fields Mauro Carvalho Chehab
2019-06-21 10:33 ` Andy Shevchenko
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®