Documentation: move oneshot trigger attributes documentation to ABI
authorRafał Miłecki <rafal@milecki.pl>
Fri, 26 Aug 2016 14:19:36 +0000 (16:19 +0200)
committerJacek Anaszewski <j.anaszewski@samsung.com>
Mon, 29 Aug 2016 13:06:32 +0000 (15:06 +0200)
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>
Documentation/ABI/testing/sysfs-class-led
Documentation/ABI/testing/sysfs-class-led-trigger-oneshot [new file with mode: 0644]
Documentation/leds/ledtrig-oneshot.txt

index 3646ec85d513f2b23c020206fa93506cb05a0ab9..86ace287d48bb28467a5ad9793e8710172417368 100644 (file)
@@ -24,7 +24,8 @@ Description:
                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.
+               /sys/class/leds/<led> once a given trigger is selected. For
+               their documentation see sysfs-class-led-trigger-*.
 
 What:          /sys/class/leds/<led>/inverted
 Date:          January 2011
diff --git a/Documentation/ABI/testing/sysfs-class-led-trigger-oneshot b/Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
new file mode 100644 (file)
index 0000000..378a3a4
--- /dev/null
@@ -0,0 +1,36 @@
+What:          /sys/class/leds/<led>/delay_on
+Date:          Jun 2012
+KernelVersion: 3.6
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Specifies for how many milliseconds the LED has to stay at
+               LED_FULL brightness after it has been armed.
+               Defaults to 100 ms.
+
+What:          /sys/class/leds/<led>/delay_off
+Date:          Jun 2012
+KernelVersion: 3.6
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Specifies for how many milliseconds the LED has to stay at
+               LED_OFF brightness after it has been armed.
+               Defaults to 100 ms.
+
+What:          /sys/class/leds/<led>/invert
+Date:          Jun 2012
+KernelVersion: 3.6
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Reverse the blink logic. If set to 0 (default) blink on for
+               delay_on ms, then blink off for delay_off ms, leaving the LED
+               normally off. If set to 1, blink off for delay_off ms, then
+               blink on for delay_on ms, leaving the LED normally on.
+               Setting this value also immediately changes the LED state.
+
+What:          /sys/class/leds/<led>/shot
+Date:          Jun 2012
+KernelVersion: 3.6
+Contact:       linux-leds@vger.kernel.org
+Description:
+               Write any non-empty string to signal an events, this starts a
+               blink sequence if not already running.
index 07cd1fa41a3a50abe718fefbf952cc4cd756e325..fe57474a12e2af1e9210f14b175cae42d0d1b834 100644 (file)
@@ -21,24 +21,8 @@ below:
 
   echo oneshot > trigger
 
-This adds the following sysfs attributes to the LED:
-
-  delay_on - specifies for how many milliseconds the LED has to stay at
-             LED_FULL brightness after it has been armed.
-             Default to 100 ms.
-
-  delay_off - specifies for how many milliseconds the LED has to stay at
-              LED_OFF brightness after it has been armed.
-              Default to 100 ms.
-
-  invert - reverse the blink logic.  If set to 0 (default) blink on for delay_on
-           ms, then blink off for delay_off ms, leaving the LED normally off.  If
-           set to 1, blink off for delay_off ms, then blink on for delay_on ms,
-           leaving the LED normally on.
-           Setting this value also immediately change the LED state.
-
-  shot - write any non-empty string to signal an events, this starts a blink
-         sequence if not already running.
+This adds sysfs attributes to the LED that are documented in:
+Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
 
 Example use-case: network devices, initialization: