Skip to content

Commit

Permalink
ABI: better identificate tables
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Mauro Carvalho Chehab authored and Greg Kroah-Hartman committed Jun 14, 2019
1 parent d59f0ec commit 1107049
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions Documentation/ABI/testing/sysfs-class-backlight-driver-lm3533
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions Documentation/ABI/testing/sysfs-class-led-driver-lm3533
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Documentation/ABI/testing/sysfs-class-leds-gt683r
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ 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
2 - breathing

Normal: LEDs are fully on when enabled
Audio: LEDs brightness depends on sound level
Breathing: LEDs brightness varies at human breathing rate
Breathing: LEDs brightness varies at human breathing rate
2 changes: 1 addition & 1 deletion Documentation/ABI/testing/sysfs-driver-hid-roccat-kone
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1107049

Please sign in to comment.