lkml.org 
[lkml]   [2016]   [Aug]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH V2] Documentation: move oneshot trigger attributes documentation to ABI
From
Date
Hi Rafał,

On 08/26/2016 04:19 PM, Rafał Miłecki wrote:
> From: Rafał Miłecki <rafal@milecki.pl>
>
> 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>
> ---
> V2: s/Default/Defaults/
> s/ / /
> s/change/changes/
> ---
> Documentation/ABI/testing/sysfs-class-led | 3 +-
> .../ABI/testing/sysfs-class-led-trigger-oneshot | 36 ++++++++++++++++++++++
> Documentation/leds/ledtrig-oneshot.txt | 20 ++----------
> 3 files changed, 40 insertions(+), 19 deletions(-)
> create mode 100644 Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
>
> diff --git a/Documentation/ABI/testing/sysfs-class-led b/Documentation/ABI/testing/sysfs-class-led
> index 3646ec8..86ace28 100644
> --- a/Documentation/ABI/testing/sysfs-class-led
> +++ b/Documentation/ABI/testing/sysfs-class-led
> @@ -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
> index 0000000..378a3a4
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
> @@ -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.
> diff --git a/Documentation/leds/ledtrig-oneshot.txt b/Documentation/leds/ledtrig-oneshot.txt
> index 07cd1fa..fe57474 100644
> --- a/Documentation/leds/ledtrig-oneshot.txt
> +++ b/Documentation/leds/ledtrig-oneshot.txt
> @@ -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:
>
>

Applied, thanks.

--
Best regards,
Jacek Anaszewski

\
 
 \ /
  Last update: 2016-09-17 09:58    [W:0.084 / U:0.440 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site