linux-kernel - Re: [PATCH] Documentation: move oneshot trigger attributes documentation to ABI

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-id: <5ab3274c-4c74-d6a3-f19a-1025b1b5f2b9@samsung.com>
Date:   Fri, 26 Aug 2016 15:50:28 +0200
From:   Jacek Anaszewski <j.anaszewski@...sung.com>
To:     Rafał Miłecki <zajec5@...il.com>,
        Richard Purdie <rpurdie@...ys.net>
Cc:     Greg KH <gregkh@...uxfoundation.org>,
        Rafał Miłecki <rafal@...ecki.pl>,
        Jonathan Corbet <corbet@....net>,
        open list <linux-kernel@...r.kernel.org>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>
Subject: Re: [PATCH] Documentation: move oneshot trigger attributes
 documentation to ABI

Hi Rafał,

Thanks for the patch. We could possibly correct one linguistic
issue whilst we are at it. Please take a look below.

On 08/25/2016 11:38 AM, Rafał Miłecki wrote:
> From: Rafał Miłecki <rafal@...ecki.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.
>
> Signed-off-by: Rafał Miłecki <rafal@...ecki.pl>
> ---
>  Documentation/ABI/testing/sysfs-class-led          |  3 +-
>  .../ABI/testing/sysfs-class-led-trigger-oneshot    | 37 ++++++++++++++++++++++
>  Documentation/leds/ledtrig-oneshot.txt             | 20 ++----------
>  3 files changed, 41 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..401cbe6
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-led-trigger-oneshot
> @@ -0,0 +1,37 @@
> +What:		/sys/class/leds/<led>/delay_on
> +Date:		Jun 2012
> +KernelVersion:	3.6
> +Contact:	linux-leds@...r.kernel.org
> +Description:
> +		Specifies for how many milliseconds the LED has to stay at
> +		LED_FULL brightness after it has been armed.
> +		Default to 100 ms.

s/Default/Defaults/

> +
> +
> +What:		/sys/class/leds/<led>/delay_off
> +Date:		Jun 2012
> +KernelVersion:	3.6
> +Contact:	linux-leds@...r.kernel.org
> +Description:
> +		Specifies for how many milliseconds the LED has to stay at
> +		LED_OFF brightness after it has been armed.
> +		Default to 100 ms.

s/Default/Defaults/

> +
> +What:		/sys/class/leds/<led>/invert
> +Date:		Jun 2012
> +KernelVersion:	3.6
> +Contact:	linux-leds@...r.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 change the LED state.
> +
> +What:		/sys/class/leds/<led>/shot
> +Date:		Jun 2012
> +KernelVersion:	3.6
> +Contact:	linux-leds@...r.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:
>
>


-- 
Best regards,
Jacek Anaszewski