[PATCH] leds: uleds documentation fixes

[PATCH] leds: uleds documentation fixes

[Craig McQueen]

* Add max_brightness field to struct for setup.
* Reads are a signed int value, not a single unsigned byte value.
---
 Documentation/leds/uleds.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/leds/uleds.rst b/Documentation/leds/uleds.rst
index 83221098009c..4077745dae00 100644
--- a/Documentation/leds/uleds.rst
+++ b/Documentation/leds/uleds.rst
@@ -17,16 +17,16 @@ structure to it (found in kernel public header file linux/uleds.h)::
 
     struct uleds_user_dev {
 	char name[LED_MAX_NAME_SIZE];
+	int max_brightness;
     };
 
 A new LED class device will be created with the name given. The name can be
 any valid sysfs device node name, but consider using the LED class naming
 convention of "devicename:color:function".
 
-The current brightness is found by reading a single byte from the character
-device. Values are unsigned: 0 to 255. Reading will block until the brightness
-changes. The device node can also be polled to notify when the brightness value
-changes.
+The current brightness is found by reading an int value from the character
+device. Reading will block until the brightness changes. The device node can
+also be polled to notify when the brightness value changes.
 
 The LED class device will be removed when the open file handle to /dev/uleds
 is closed.
-- 
2.48.1

Re: [PATCH] leds: uleds documentation fixes

[Lee Jones]

On Tue, 11 Mar 2025, Craig McQueen wrote:

> * Add max_brightness field to struct for setup.
> * Reads are a signed int value, not a single unsigned byte value.

SoB

You must remember to use `-s` when committing patches.

> ---
>  Documentation/leds/uleds.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/leds/uleds.rst b/Documentation/leds/uleds.rst
> index 83221098009c..4077745dae00 100644
> --- a/Documentation/leds/uleds.rst
> +++ b/Documentation/leds/uleds.rst
> @@ -17,16 +17,16 @@ structure to it (found in kernel public header file linux/uleds.h)::
>  
>      struct uleds_user_dev {
>  	char name[LED_MAX_NAME_SIZE];
> +	int max_brightness;
>      };
>  
>  A new LED class device will be created with the name given. The name can be
>  any valid sysfs device node name, but consider using the LED class naming
>  convention of "devicename:color:function".
>  
> -The current brightness is found by reading a single byte from the character
> -device. Values are unsigned: 0 to 255. Reading will block until the brightness
> -changes. The device node can also be polled to notify when the brightness value
> -changes.
> +The current brightness is found by reading an int value from the character
> +device. Reading will block until the brightness changes. The device node can
> +also be polled to notify when the brightness value changes.
>  
>  The LED class device will be removed when the open file handle to /dev/uleds
>  is closed.
> -- 
> 2.48.1
> 
> 

-- 
Lee Jones [李琼斯]

Re: [PATCH] leds: uleds documentation fixes

[Lee Jones]

On Fri, 14 Mar 2025, Lee Jones wrote:

> On Tue, 11 Mar 2025, Craig McQueen wrote:
> 
> > * Add max_brightness field to struct for setup.
> > * Reads are a signed int value, not a single unsigned byte value.
> 
> SoB
> 
> You must remember to use `-s` when committing patches.

And run checkpatch.pl and Cc: LKML.

-- 
Lee Jones [李琼斯]

Re: [PATCH] leds: uleds documentation fixes

[Lee Jones]

On Fri, 14 Mar 2025, Lee Jones wrote:

> On Fri, 14 Mar 2025, Lee Jones wrote:
> 
> > On Tue, 11 Mar 2025, Craig McQueen wrote:
> > 
> > > * Add max_brightness field to struct for setup.
> > > * Reads are a signed int value, not a single unsigned byte value.
> > 
> > SoB
> > 
> > You must remember to use `-s` when committing patches.
> 
> And run checkpatch.pl and Cc: LKML.

And get_maintainer.pl

Etc!  =:-)

-- 
Lee Jones [李琼斯]