cleanup LED documentation and make it match reality
authorPavel Machek <pavel@ucw.cz>
Mon, 3 Oct 2016 08:10:50 +0000 (10:10 +0200)
committerJacek Anaszewski <j.anaszewski@samsung.com>
Tue, 22 Nov 2016 11:07:03 +0000 (12:07 +0100)
sysfs-class-led fails to mention some important details. Also fix led
vs LED and english.

Signed-off-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
Documentation/ABI/testing/sysfs-class-led

index 86ace287d48bb28467a5ad9793e8710172417368..491cdeedc195041a7f611f10490cc4ca569aeb9a 100644 (file)
@@ -4,16 +4,24 @@ KernelVersion:        2.6.17
 Contact:       Richard Purdie <rpurdie@rpsys.net>
 Description:
                Set the brightness of the LED. Most LEDs don't
-               have hardware brightness support so will just be turned on for
+               have hardware brightness support, so will just be turned on for
                non-zero brightness settings. The value is between 0 and
                /sys/class/leds/<led>/max_brightness.
 
+               Writing 0 to this file clears active trigger.
+
+               Writing non-zero to this file while trigger is active changes the
+               top brightness trigger is going to use.
+
 What:          /sys/class/leds/<led>/max_brightness
 Date:          March 2006
 KernelVersion: 2.6.17
 Contact:       Richard Purdie <rpurdie@rpsys.net>
 Description:
-               Maximum brightness level for this led, default is 255 (LED_FULL).
+               Maximum brightness level for this LED, default is 255 (LED_FULL).
+
+               If the LED does not support different brightness levels, this
+               should be 1.
 
 What:          /sys/class/leds/<led>/trigger
 Date:          March 2006
@@ -21,7 +29,7 @@ KernelVersion:        2.6.17
 Contact:       Richard Purdie <rpurdie@rpsys.net>
 Description:
                Set the trigger for this LED. A trigger is a kernel based source
-               of led events.
+               of LED events.
                You can change triggers in a similar manner to the way an IO
                scheduler is chosen. Trigger specific parameters can appear in
                /sys/class/leds/<led> once a given trigger is selected. For