ABI: better identificate tables
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Fri, 14 Jun 2019 02:04:10 +0000 (23:04 -0300)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 14 Jun 2019 16:17:12 +0000 (18:17 +0200)
When parsing via script, it is important to know if the script
should consider a description as a literal block that should
be displayed as-is, or if the description can be considered
as a normal text.

Change descriptions to ensure that the preceding line of a table
ends with a colon. That makes easy to identify the need of a
literal block.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra
Documentation/ABI/testing/sysfs-class-backlight-driver-lm3533
Documentation/ABI/testing/sysfs-class-led-driver-lm3533
Documentation/ABI/testing/sysfs-class-leds-gt683r
Documentation/ABI/testing/sysfs-driver-hid-roccat-kone

index 16020b31ae640eddda12cae66d54f48a7c4cb65b..5d41ebadf15e9250adb9a6d5258e21281b23870d 100644 (file)
@@ -5,7 +5,7 @@ Description:    It is possible to switch the cpi setting of the mouse with the
                press of a button.
                When read, this file returns the raw number of the actual cpi
                setting reported by the mouse. This number has to be further
-               processed to receive the real dpi value.
+               processed to receive the real dpi value:
 
                VALUE DPI
                1     400
index 77cf7ac949af76a818f7e3836ff141041aa941d7..c0e0a9ae7b3d9bfb4a344d00490759d2475e013d 100644 (file)
@@ -4,7 +4,7 @@ KernelVersion:  3.5
 Contact:       Johan Hovold <jhovold@gmail.com>
 Description:
                Get the ALS output channel used as input in
-               ALS-current-control mode (0, 1), where
+               ALS-current-control mode (0, 1), where:
 
                0 - out_current0 (backlight 0)
                1 - out_current1 (backlight 1)
@@ -28,7 +28,7 @@ Date:         April 2012
 KernelVersion: 3.5
 Contact:       Johan Hovold <jhovold@gmail.com>
 Description:
-               Set the brightness-mapping mode (0, 1), where
+               Set the brightness-mapping mode (0, 1), where:
 
                0 - exponential mode
                1 - linear mode
@@ -38,7 +38,7 @@ Date:         April 2012
 KernelVersion: 3.5
 Contact:       Johan Hovold <jhovold@gmail.com>
 Description:
-               Set the PWM-input control mask (5 bits), where
+               Set the PWM-input control mask (5 bits), where:
 
                bit 5 - PWM-input enabled in Zone 4
                bit 4 - PWM-input enabled in Zone 3
index 620ebb3b9baa39b1c2e5472a613324ae13d68f13..e4c89b261546c367463561adf0017ca7ea18a565 100644 (file)
@@ -4,7 +4,7 @@ KernelVersion:  3.5
 Contact:       Johan Hovold <jhovold@gmail.com>
 Description:
                Set the ALS output channel to use as input in
-               ALS-current-control mode (1, 2), where
+               ALS-current-control mode (1, 2), where:
 
                1 - out_current1
                2 - out_current2
@@ -22,7 +22,7 @@ Date:         April 2012
 KernelVersion: 3.5
 Contact:       Johan Hovold <jhovold@gmail.com>
 Description:
-               Set the pattern generator fall and rise times (0..7), where
+               Set the pattern generator fall and rise times (0..7), where:
 
                0 - 2048 us
                1 - 262 ms
@@ -45,7 +45,7 @@ Date:         April 2012
 KernelVersion: 3.5
 Contact:       Johan Hovold <jhovold@gmail.com>
 Description:
-               Set the brightness-mapping mode (0, 1), where
+               Set the brightness-mapping mode (0, 1), where:
 
                0 - exponential mode
                1 - linear mode
@@ -55,7 +55,7 @@ Date:         April 2012
 KernelVersion: 3.5
 Contact:       Johan Hovold <jhovold@gmail.com>
 Description:
-               Set the PWM-input control mask (5 bits), where
+               Set the PWM-input control mask (5 bits), where:
 
                bit 5 - PWM-input enabled in Zone 4
                bit 4 - PWM-input enabled in Zone 3
index e4fae6026e793a080fe4d1814bad04b110bfc70a..6adab27f646e668eeb46d92ee5fe6ed560ad15c2 100644 (file)
@@ -5,7 +5,7 @@ Contact:        Janne Kanniainen <janne.kanniainen@gmail.com>
 Description:
                Set the mode of LEDs. You should notice that changing the mode
                of one LED will update the mode of its two sibling devices as
-               well.
+               well. Possible values are:
 
                0 - normal
                1 - audio
@@ -13,4 +13,4 @@ Description:
 
                Normal: LEDs are fully on when enabled
                Audio:  LEDs brightness depends on sound level
-               Breathing: LEDs brightness varies at human breathing rate
\ No newline at end of file
+               Breathing: LEDs brightness varies at human breathing rate
index 3ca3971109bf627fc299fa971c624c953619841e..8f7982c70d72cc797a18c15720056bb96f573ebc 100644 (file)
@@ -5,7 +5,7 @@ Description:    It is possible to switch the dpi setting of the mouse with the
                press of a button.
                When read, this file returns the raw number of the actual dpi
                setting reported by the mouse. This number has to be further
-               processed to receive the real dpi value.
+               processed to receive the real dpi value:
 
                VALUE DPI
                1     800