Re: [PATCH] Documentation: leds: improve readibility of multicolor doc

[Jean-Michel Hautbois <jeanmichel.hautbois@yoseli.org>]

Hi Bagas,

On 23/04/2025 05:01, Bagas Sanjaya wrote:
> On Mon, Apr 21, 2025 at 06:48:10PM +0200, Jean-Michel Hautbois wrote:
>> +.. code-block:: console
>> +
>> +    root:/sys/class/leds/multicolor:status# ls -lR
> 
> The equivalent is ``ls -lR /sys/class/leds/multicolor``.
> 

This patch was only to add markups, I did not want to change the content 
more than that. The result of ls -lR must also be in the same 
code-block, so I am not certain your proposal is equivalent ?

>> +    -rw-r--r--    1 root     root          4096 Oct 19 16:16 brightness
>> +    -r--r--r--    1 root     root          4096 Oct 19 16:16 max_brightness
>> +    -r--r--r--    1 root     root          4096 Oct 19 16:16 multi_index
>> +    -rw-r--r--    1 root     root          4096 Oct 19 16:16 multi_intensity
>> +
>> +..
>>   
>> <snipped>...
>>
>> @@ -71,16 +79,28 @@ may want to dim the LED color group to half.  The user would write a value of
>>   128 to the global brightness file then the values written to each LED will be
>>   adjusted base on this value.
>>   
>> -cat /sys/class/leds/multicolor:status/max_brightness
>> -255
>> -echo 128 > /sys/class/leds/multicolor:status/brightness
>> +.. code-block:: console
>> +
>> +    # cat /sys/class/leds/multicolor:status/max_brightness
>> +    255
>> +    # echo 128 > /sys/class/leds/multicolor:status/brightness
>>   
>> -adjusted_red_value = 128 * 138/255 = 69
>> -adjusted_green_value = 128 * 43/255 = 21
>> -adjusted_blue_value = 128 * 226/255 = 113
>> +..
>> +
>> +.. code-block:: none
>> +
>> +    adjusted_red_value = 128 * 138/255 = 69
>> +    adjusted_green_value = 128 * 43/255 = 21
>> +    adjusted_blue_value = 128 * 226/255 = 113
>> +
>> +..
> 
> Are these adjusted values intended to be part of previous block on brightness
> status? If not, I'd like to interleave these two blocks with "The adjusted
> values are now::".

Interesting, yes, it could be added.

Thanks !
JM