OSDN Git Service

ABI: fix some syntax issues at the ABI database
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 14 Jun 2019 02:04:07 +0000 (23:04 -0300)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 14 Jun 2019 16:17:11 +0000 (18:17 +0200)
On those three files, the ABI representation described at
README are violated.

- at sysfs-bus-iio-proximity-as3935:
a ':' character is missing after "What"

- at sysfs-class-devfreq:
there's a typo at Description

- at sysfs-class-cxl, it is using the ":" character at a
file preamble, causing it to be misinterpreted as a
tag.

- On the other files, instead of "What", they use "Where".

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Acked-by: Andrew Donnellan <ajd@linux.ibm.com> # cxl
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
12 files changed:
Documentation/ABI/testing/pstore
Documentation/ABI/testing/sysfs-bus-event_source-devices-format
Documentation/ABI/testing/sysfs-bus-i2c-devices-hm6352
Documentation/ABI/testing/sysfs-bus-iio-distance-srf08
Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935
Documentation/ABI/testing/sysfs-bus-pci-devices-cciss
Documentation/ABI/testing/sysfs-bus-usb-devices-usbsevseg
Documentation/ABI/testing/sysfs-class-cxl
Documentation/ABI/testing/sysfs-class-devfreq
Documentation/ABI/testing/sysfs-class-powercap
Documentation/ABI/testing/sysfs-kernel-fscaps
Documentation/ABI/testing/sysfs-kernel-vmcoreinfo

index 5fca9f5..8d6e48f 100644 (file)
@@ -1,4 +1,4 @@
-Where:         /sys/fs/pstore/... (or /dev/pstore/...)
+What:          /sys/fs/pstore/... (or /dev/pstore/...)
 Date:          March 2011
 Kernel Version: 2.6.39
 Contact:       tony.luck@intel.com
index 77f47ff..b6f8748 100644 (file)
@@ -1,4 +1,4 @@
-Where:         /sys/bus/event_source/devices/<dev>/format
+What:          /sys/bus/event_source/devices/<dev>/format
 Date:          January 2012
 Kernel Version: 3.3
 Contact:       Jiri Olsa <jolsa@redhat.com>
index feb2e4a..29bd447 100644 (file)
@@ -1,18 +1,18 @@
-Where:         /sys/bus/i2c/devices/.../heading0_input
+What:          /sys/bus/i2c/devices/.../heading0_input
 Date:          April 2010
 Kernel Version: 2.6.36?
 Contact:       alan.cox@intel.com
 Description:   Reports the current heading from the compass as a floating
                point value in degrees.
 
-Where:         /sys/bus/i2c/devices/.../power_state
+What:          /sys/bus/i2c/devices/.../power_state
 Date:          April 2010
 Kernel Version: 2.6.36?
 Contact:       alan.cox@intel.com
 Description:   Sets the power state of the device. 0 sets the device into
                sleep mode, 1 wakes it up.
 
-Where:         /sys/bus/i2c/devices/.../calibration
+What:          /sys/bus/i2c/devices/.../calibration
 Date:          April 2010
 Kernel Version: 2.6.36?
 Contact:       alan.cox@intel.com
index 0a1ca14..a133fd8 100644 (file)
@@ -1,4 +1,4 @@
-What           /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
+What:          /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
 Date:          January 2017
 KernelVersion: 4.11
 Contact:       linux-iio@vger.kernel.org
@@ -6,7 +6,7 @@ Description:
                Show or set the gain boost of the amp, from 0-31 range.
                default 31
 
-What           /sys/bus/iio/devices/iio:deviceX/sensor_max_range
+What:          /sys/bus/iio/devices/iio:deviceX/sensor_max_range
 Date:          January 2017
 KernelVersion: 4.11
 Contact:       linux-iio@vger.kernel.org
index 9a17ab5..c59d953 100644 (file)
@@ -1,4 +1,4 @@
-What           /sys/bus/iio/devices/iio:deviceX/in_proximity_input
+What:          /sys/bus/iio/devices/iio:deviceX/in_proximity_input
 Date:          March 2014
 KernelVersion: 3.15
 Contact:       Matt Ranostay <matt.ranostay@konsulko.com>
@@ -6,7 +6,7 @@ Description:
                Get the current distance in meters of storm (1km steps)
                1000-40000 = distance in meters
 
-What           /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
+What:          /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity
 Date:          March 2014
 KernelVersion: 3.15
 Contact:       Matt Ranostay <matt.ranostay@konsulko.com>
index 53d99ed..eb44916 100644 (file)
@@ -1,66 +1,66 @@
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/model
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/model
 Date:          March 2009
 Kernel Version: 2.6.30
 Contact:       iss_storagedev@hp.com
 Description:   Displays the SCSI INQUIRY page 0 model for logical drive
                Y of controller X.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/rev
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/rev
 Date:          March 2009
 Kernel Version: 2.6.30
 Contact:       iss_storagedev@hp.com
 Description:   Displays the SCSI INQUIRY page 0 revision for logical
                drive Y of controller X.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/unique_id
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/unique_id
 Date:          March 2009
 Kernel Version: 2.6.30
 Contact:       iss_storagedev@hp.com
 Description:   Displays the SCSI INQUIRY page 83 serial number for logical
                drive Y of controller X.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/vendor
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/vendor
 Date:          March 2009
 Kernel Version: 2.6.30
 Contact:       iss_storagedev@hp.com
 Description:   Displays the SCSI INQUIRY page 0 vendor for logical drive
                Y of controller X.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/block:cciss!cXdY
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/block:cciss!cXdY
 Date:          March 2009
 Kernel Version: 2.6.30
 Contact:       iss_storagedev@hp.com
 Description:   A symbolic link to /sys/block/cciss!cXdY
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/rescan
+What:          /sys/bus/pci/devices/<dev>/ccissX/rescan
 Date:          August 2009
 Kernel Version:        2.6.31
 Contact:       iss_storagedev@hp.com
 Description:   Kicks of a rescan of the controller to discover logical
                drive topology changes.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/lunid
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/lunid
 Date:          August 2009
 Kernel Version: 2.6.31
 Contact:       iss_storagedev@hp.com
 Description:   Displays the 8-byte LUN ID used to address logical
                drive Y of controller X.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/raid_level
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/raid_level
 Date:          August 2009
 Kernel Version: 2.6.31
 Contact:       iss_storagedev@hp.com
 Description:   Displays the RAID level of logical drive Y of
                controller X.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/cXdY/usage_count
+What:          /sys/bus/pci/devices/<dev>/ccissX/cXdY/usage_count
 Date:          August 2009
 Kernel Version: 2.6.31
 Contact:       iss_storagedev@hp.com
 Description:   Displays the usage count (number of opens) of logical drive Y
                of controller X.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/resettable
+What:          /sys/bus/pci/devices/<dev>/ccissX/resettable
 Date:          February 2011
 Kernel Version:        2.6.38
 Contact:       iss_storagedev@hp.com
@@ -71,7 +71,7 @@ Description:  Value of 1 indicates the controller can honor the reset_devices
                a dump device, as kdump requires resetting the device in order
                to work reliably.
 
-Where:         /sys/bus/pci/devices/<dev>/ccissX/transport_mode
+What:          /sys/bus/pci/devices/<dev>/ccissX/transport_mode
 Date:          July 2011
 Kernel Version:        3.0
 Contact:       iss_storagedev@hp.com
index 70d00df..f6199b3 100644 (file)
@@ -1,12 +1,12 @@
-Where:         /sys/bus/usb/.../powered
+What:          /sys/bus/usb/.../powered
 Date:          August 2008
 Kernel Version:        2.6.26
 Contact:       Harrison Metzger <harrisonmetz@gmail.com>
 Description:   Controls whether the device's display will powered.
                A value of 0 is off and a non-zero value is on.
 
-Where:         /sys/bus/usb/.../mode_msb
-Where:         /sys/bus/usb/.../mode_lsb
+What:          /sys/bus/usb/.../mode_msb
+What:          /sys/bus/usb/.../mode_lsb
 Date:          August 2008
 Kernel Version:        2.6.26
 Contact:       Harrison Metzger <harrisonmetz@gmail.com>
@@ -16,7 +16,7 @@ Description:  Controls the devices display mode.
                for an 8 character display the values are
                        MSB 0x08; LSB 0xFF.
 
-Where:         /sys/bus/usb/.../textmode
+What:          /sys/bus/usb/.../textmode
 Date:          August 2008
 Kernel Version:        2.6.26
 Contact:       Harrison Metzger <harrisonmetz@gmail.com>
@@ -25,13 +25,13 @@ Description:        Controls the way the device interprets its text buffer.
                hex:    each character is between 0-15
                ascii:  each character is between '0'-'9' and 'A'-'F'.
 
-Where:         /sys/bus/usb/.../text
+What:          /sys/bus/usb/.../text
 Date:          August 2008
 Kernel Version:        2.6.26
 Contact:       Harrison Metzger <harrisonmetz@gmail.com>
 Description:   The text (or data) for the device to display
 
-Where:         /sys/bus/usb/.../decimals
+What:          /sys/bus/usb/.../decimals
 Date:          August 2008
 Kernel Version:        2.6.26
 Contact:       Harrison Metzger <harrisonmetz@gmail.com>
index bbbabff..7970e37 100644 (file)
@@ -1,6 +1,6 @@
-Note: Attributes that are shared between devices are stored in the directory
-pointed to by the symlink device/.
-Example: The real path of the attribute /sys/class/cxl/afu0.0s/irqs_max is
+Please note that attributes that are shared between devices are stored in
+the directory pointed to by the symlink device/.
+For example, the real path of the attribute /sys/class/cxl/afu0.0s/irqs_max is
 /sys/class/cxl/afu0.0s/device/irqs_max, i.e. /sys/class/cxl/afu0.0/irqs_max.
 
 
index ee39aca..01196e1 100644 (file)
@@ -47,7 +47,7 @@ Description:
 What:          /sys/class/devfreq/.../trans_stat
 Date:          October 2012
 Contact:       MyungJoo Ham <myungjoo.ham@samsung.com>
-Descrtiption:
+Description:
                This ABI shows the statistics of devfreq behavior on a
                specific device. It shows the time spent in each state and
                the number of transitions between states.
index db3b3ff..f333a0c 100644 (file)
@@ -147,6 +147,6 @@ What:               /sys/class/powercap/.../<power zone>/enabled
 Date:          September 2013
 KernelVersion: 3.13
 Contact:       linux-pm@vger.kernel.org
-Description
+Description:
                This allows to enable/disable power capping at power zone level.
                This applies to current power zone and its children.
index 50a3033..bcff346 100644 (file)
@@ -2,7 +2,7 @@ What:           /sys/kernel/fscaps
 Date:          February 2011
 KernelVersion: 2.6.38
 Contact:       Ludwig Nussel <ludwig.nussel@suse.de>
-Description
+Description:
                Shows whether file system capabilities are honored
                when executing a binary
 
index 7bd8116..1f1087a 100644 (file)
@@ -4,7 +4,7 @@ KernelVersion:  2.6.24
 Contact:       Ken'ichi Ohmichi <oomichi@mxs.nes.nec.co.jp>
                Kexec Mailing List <kexec@lists.infradead.org>
                Vivek Goyal <vgoyal@redhat.com>
-Description
+Description:
                Shows physical address and size of vmcoreinfo ELF note.
                First value contains physical address of note in hex and
                second value contains the size of note in hex. This ELF