Skip to contentSkip to conversation

leds: Adjust documentation of brightness sysfs node

PATCH Superseded Andy Shevchenko 2 participants 4 messages Mar 10 – Mar 19 LED

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 leds: Adjust documentation of brightness sysfs node

Adjust documentation of brightness sysfs node about accepted value range. The code accepts only decimal values. We may not relax that due to different readings for, e.g., octal 0100, which becomes 64 instead of currently parsed 100.

---
 Documentation/ABI/testing/sysfs-class-led | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-class-led +1 -1
index 0313b82644f2..39ac8453e670 100644
@@ -22,7 +22,7 @@ Description:
 		  For additional details please refer to
 		  Documentation/leds/leds-class-multicolor.rst.
 
-		The value is between 0 and
+		The decimal value is between 0 and
 		/sys/class/leds/<led>/max_brightness.
 
 		Writing 0 to this file clears active trigger.
Signature · 1 line
2.50.1
maintainer
#1 lore raw
Quoted 15 lines · Andy Shevchenko

Adjust documentation of brightness sysfs node about accepted value range. The code accepts only decimal values. We may not relax that due to different readings for, e.g., octal 0100, which becomes 64 instead of currently parsed 100.

---
 Documentation/ABI/testing/sysfs-class-led | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-class-led +0 -0
index 0313b82644f2..39ac8453e670 100644

Documentation/ABI/testing/sysfs-class-led Description: · line 25

Quoted 5 lines
Documentation/ABI/testing/sysfs-class-led +1 -1
@@ -22,7 +22,7 @@ Description:
 		  For additional details please refer to
 		  Documentation/leds/leds-class-multicolor.rst.
 
-		The value is between 0 and
+		The decimal value is between 0 and

How about?

The value is between 0 and /sys/class/leds/<led>/max_brightness and is represented by as a decimal.

Quoted 7 lines
Documentation/ABI/testing/sysfs-class-led +0 -0
 		/sys/class/leds/<led>/max_brightness.
 
 		Writing 0 to this file clears active trigger.
Signature · 1 line
2.50.1
Signature · 1 line
Lee Jones [李琼斯]
#2 lore raw
Quoted 6 lines · Lee Jones
Quoted 4 lines · Andy Shevchenko

Adjust documentation of brightness sysfs node about accepted value range. The code accepts only decimal values. We may not relax that due to different readings for, e.g., octal 0100, which becomes 64 instead of currently parsed 100.

...

Quoted 7 lines

Documentation/ABI/testing/sysfs-class-led Description: · line 25

Quoted 2 lines
Documentation/ABI/testing/sysfs-class-led +1 -1
-		The value is between 0 and
+		The decimal value is between 0 and

How about?

The value is between 0 and /sys/class/leds/<led>/max_brightness and is represented by as a decimal.

I tried to be less invasive, but I have no objection on this proposal. Can you update it whilst applying or should I send a new version?

Quoted 1 line
Quoted 1 line

/sys/class/leds/<led>/max_brightness.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#3 lore raw
Quoted 15 lines · Andy Shevchenko
Quoted 6 lines · Lee Jones
Quoted 4 lines · Andy Shevchenko

Adjust documentation of brightness sysfs node about accepted value range. The code accepts only decimal values. We may not relax that due to different readings for, e.g., octal 0100, which becomes 64 instead of currently parsed 100.

...

Quoted 5 lines

Documentation/ABI/testing/sysfs-class-led Description: · line 25

Quoted 2 lines
Documentation/ABI/testing/sysfs-class-led +1 -1
-		The value is between 0 and
+		The decimal value is between 0 and

How about?

Quoted 5 lines
Quoted 2 lines

The value is between 0 and /sys/class/leds/<led>/max_brightness and is represented by as a decimal.

I tried to be less invasive, but I have no objection on this proposal. Can you update it whilst applying or should I send a new version?

New version please. I'm done for the day.

Signature · 1 line
Lee Jones [李琼斯]