Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: move oneshot trigger attributes documentation to ABI

Documentation of sysfs interface should be in ABI in the first place.
This moves relevant part of documentation and mentions where to look for
it.
Fix trivial typos whilst we are at it.

Signed-off-by: Rafał Miłecki <rafal@milecki.pl>
Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>

authored by

Rafał Miłecki and committed by
Jacek Anaszewski
1f70cb40 1d1a77dd

+40 -19
+2 -1
Documentation/ABI/testing/sysfs-class-led
··· 24 24 of led events. 25 25 You can change triggers in a similar manner to the way an IO 26 26 scheduler is chosen. Trigger specific parameters can appear in 27 - /sys/class/leds/<led> once a given trigger is selected. 27 + /sys/class/leds/<led> once a given trigger is selected. For 28 + their documentation see sysfs-class-led-trigger-*. 28 29 29 30 What: /sys/class/leds/<led>/inverted 30 31 Date: January 2011
+36
Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
··· 1 + What: /sys/class/leds/<led>/delay_on 2 + Date: Jun 2012 3 + KernelVersion: 3.6 4 + Contact: linux-leds@vger.kernel.org 5 + Description: 6 + Specifies for how many milliseconds the LED has to stay at 7 + LED_FULL brightness after it has been armed. 8 + Defaults to 100 ms. 9 + 10 + What: /sys/class/leds/<led>/delay_off 11 + Date: Jun 2012 12 + KernelVersion: 3.6 13 + Contact: linux-leds@vger.kernel.org 14 + Description: 15 + Specifies for how many milliseconds the LED has to stay at 16 + LED_OFF brightness after it has been armed. 17 + Defaults to 100 ms. 18 + 19 + What: /sys/class/leds/<led>/invert 20 + Date: Jun 2012 21 + KernelVersion: 3.6 22 + Contact: linux-leds@vger.kernel.org 23 + Description: 24 + Reverse the blink logic. If set to 0 (default) blink on for 25 + delay_on ms, then blink off for delay_off ms, leaving the LED 26 + normally off. If set to 1, blink off for delay_off ms, then 27 + blink on for delay_on ms, leaving the LED normally on. 28 + Setting this value also immediately changes the LED state. 29 + 30 + What: /sys/class/leds/<led>/shot 31 + Date: Jun 2012 32 + KernelVersion: 3.6 33 + Contact: linux-leds@vger.kernel.org 34 + Description: 35 + Write any non-empty string to signal an events, this starts a 36 + blink sequence if not already running.
+2 -18
Documentation/leds/ledtrig-oneshot.txt
··· 21 21 22 22 echo oneshot > trigger 23 23 24 - This adds the following sysfs attributes to the LED: 25 - 26 - delay_on - specifies for how many milliseconds the LED has to stay at 27 - LED_FULL brightness after it has been armed. 28 - Default to 100 ms. 29 - 30 - delay_off - specifies for how many milliseconds the LED has to stay at 31 - LED_OFF brightness after it has been armed. 32 - Default to 100 ms. 33 - 34 - invert - reverse the blink logic. If set to 0 (default) blink on for delay_on 35 - ms, then blink off for delay_off ms, leaving the LED normally off. If 36 - set to 1, blink off for delay_off ms, then blink on for delay_on ms, 37 - leaving the LED normally on. 38 - Setting this value also immediately change the LED state. 39 - 40 - shot - write any non-empty string to signal an events, this starts a blink 41 - sequence if not already running. 24 + This adds sysfs attributes to the LED that are documented in: 25 + Documentation/ABI/testing/sysfs-class-led-trigger-oneshot 42 26 43 27 Example use-case: network devices, initialization: 44 28