ABI: sysfs-driver-mlxreg-io: fix the what fields
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Fri, 21 Jun 2019 09:54:25 +0000 (06:54 -0300)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 21 Jun 2019 15:06:35 +0000 (17:06 +0200)
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>
Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/ABI/stable/sysfs-driver-mlxreg-io

index 156319fc5b80a9db21ccb5ff211d623c7b1f7a97..3544968f43cc05f0edafbd93187df3999af6e424 100644 (file)
@@ -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