Re: [PATCH 33/33] docs: ABI: unify /sys/class/leds//max_brightness documentation

2020-10-29 Thread Jacek Anaszewski

Hi Mauro,

Patch title needs fixing:

s/max_brightness/brightness/

On 10/28/20 3:23 PM, Mauro Carvalho Chehab wrote:

This ABI is defined twice, one for normal leds and another
one for multicolor ones.

Ensure that just one definition is there at ABI.

Signed-off-by: Mauro Carvalho Chehab 
---
  Documentation/ABI/testing/sysfs-class-led | 25 ---
  .../ABI/testing/sysfs-class-led-multicolor| 23 +
  2 files changed, 28 insertions(+), 20 deletions(-)


[...]

+
  What: /sys/class/leds//max_brightness
  Date: March 2006
  KernelVersion:2.6.17
diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor 
b/Documentation/ABI/testing/sysfs-class-led-multicolor
index eeeddcbdbbe3..16fc827b10cb 100644
--- a/Documentation/ABI/testing/sysfs-class-led-multicolor
+++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
@@ -1,20 +1,3 @@
-What:  /sys/class/leds//brightness
-Date:  March 2020
-KernelVersion: 5.9
-Contact:   Dan Murphy 
-Description:   read/write
-   Writing to this file will update all LEDs within the group to a
-   calculated percentage of what each color LED intensity is set
-   to. The percentage is calculated for each grouped LED via the
-   equation below:



--
Best regards,
Jacek Anaszewski


Re: [PATCH 33/33] docs: ABI: unify /sys/class/leds//max_brightness documentation

2020-10-29 Thread Pavel Machek
On Wed 2020-10-28 15:23:31, Mauro Carvalho Chehab wrote:
> This ABI is defined twice, one for normal leds and another
> one for multicolor ones.
> 
> Ensure that just one definition is there at ABI.
> 
> Signed-off-by: Mauro Carvalho Chehab 

Acked-by: Pavel Machek 

-- 
http://www.livejournal.com/~pavelmachek


signature.asc
Description: PGP signature


[PATCH 33/33] docs: ABI: unify /sys/class/leds//max_brightness documentation

2020-10-28 Thread Mauro Carvalho Chehab
This ABI is defined twice, one for normal leds and another
one for multicolor ones.

Ensure that just one definition is there at ABI.

Signed-off-by: Mauro Carvalho Chehab 
---
 Documentation/ABI/testing/sysfs-class-led | 25 ---
 .../ABI/testing/sysfs-class-led-multicolor| 23 +
 2 files changed, 28 insertions(+), 20 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-class-led 
b/Documentation/ABI/testing/sysfs-class-led
index 0ed5c2629c6f..2e24ac3bd7ef 100644
--- a/Documentation/ABI/testing/sysfs-class-led
+++ b/Documentation/ABI/testing/sysfs-class-led
@@ -3,9 +3,26 @@ Date:  March 2006
 KernelVersion: 2.6.17
 Contact:   Richard Purdie 
 Description:
-   Set the brightness of the LED. Most LEDs don't
-   have hardware brightness support, so will just be turned on for
-   non-zero brightness settings. The value is between 0 and
+   Set the brightness of the LED.
+
+   Most LEDs don't have hardware brightness support, so will
+   just be turned on for non-zero brightness settings.
+
+   .. Note::
+
+ For multicolor LEDs, writing to this file will update all
+ LEDs within the group to a calculated percentage of what
+ each color LED intensity is set to.
+
+ The percentage is calculated for each grouped LED via
+ the equation below::
+
+   led_brightness = brightness * multi_intensity/max_brightness
+
+ For additional details please refer to
+ Documentation/leds/leds-class-multicolor.rst.
+
+   The value is between 0 and
/sys/class/leds//max_brightness.
 
Writing 0 to this file clears active trigger.
@@ -13,6 +30,8 @@ Description:
Writing non-zero to this file while trigger is active changes 
the
top brightness trigger is going to use.
 
+
+
 What:  /sys/class/leds//max_brightness
 Date:  March 2006
 KernelVersion: 2.6.17
diff --git a/Documentation/ABI/testing/sysfs-class-led-multicolor 
b/Documentation/ABI/testing/sysfs-class-led-multicolor
index eeeddcbdbbe3..16fc827b10cb 100644
--- a/Documentation/ABI/testing/sysfs-class-led-multicolor
+++ b/Documentation/ABI/testing/sysfs-class-led-multicolor
@@ -1,20 +1,3 @@
-What:  /sys/class/leds//brightness
-Date:  March 2020
-KernelVersion: 5.9
-Contact:   Dan Murphy 
-Description:   read/write
-   Writing to this file will update all LEDs within the group to a
-   calculated percentage of what each color LED intensity is set
-   to. The percentage is calculated for each grouped LED via the
-   equation below:
-
-   led_brightness = brightness * multi_intensity/max_brightness
-
-   For additional details please refer to
-   Documentation/leds/leds-class-multicolor.rst.
-
-   The value of the LED is from 0 to
-   /sys/class/leds//max_brightness.
 
 What:  /sys/class/leds//multi_index
 Date:  March 2020
@@ -25,6 +8,9 @@ Description:   read
as an array of strings as they are indexed in the
multi_intensity file.
 
+   For additional details please refer to
+   Documentation/leds/leds-class-multicolor.rst.
+
 What:  /sys/class/leds//multi_intensity
 Date:  March 2020
 KernelVersion: 5.9
@@ -33,3 +19,6 @@ Description:  read/write
This file contains array of integers. Order of components is
described by the multi_index array. The maximum intensity should
not exceed /sys/class/leds//max_brightness.
+
+   For additional details please refer to
+   Documentation/leds/leds-class-multicolor.rst.
-- 
2.26.2