Input: yealink.rst: Fix typos and wording

[PATCH v3] Input: yealink.rst: Fix typos and wording

Posted by Manuel Ebner 2 weeks, 5 days ago

Improve readability.

Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
CC: Randy Dunlap <rdunlap@infradead.org>
---
[v3]
 fix wording
 droped white-space fixes

[v2]
 add ']' instead of remove '[' as randy suggested
 fix a couple more issues in the file

[v1]
 https://lore.kernel.org/all/20260904121026.759218-3-manuelebnerli@mailbox.org/
---
 Documentation/input/devices/yealink.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/input/devices/yealink.rst b/Documentation/input/devices/yealink.rst
index bb5a1aafe..de1460b6b 100644
--- a/Documentation/input/devices/yealink.rst
+++ b/Documentation/input/devices/yealink.rst
@@ -120,9 +120,10 @@ Reading /sys/../lineX will return the format string with its current value.
 Writing to /sys/../lineX will set the corresponding LCD line.
 
  - Excess characters are ignored.
- - If less characters are written than allowed, the remaining digits are
+ - If fewer characters than allowed are written, the remaining digits are
    unchanged.
- - The tab '\t'and '\n' char does not overwrite the original content.
+ - The tab '\t' and newline '\n' characters do not overwrite the original
+   content.
  - Writing a space to an icon will always hide its content.
 
   Example::
@@ -205,7 +206,7 @@ Troubleshooting
 :Q: Module yealink compiled and installed without any problem but phone
     is not initialized and does not react to any actions.
 :A: If you see something like:
-    hiddev0: USB HID v1.00 Device [Yealink Network Technology Ltd. VOIP USB Phone
+    hiddev0: USB HID v1.00 Device [Yealink Network Technology Ltd. VOIP USB Phone]
     in dmesg, it means that the hid driver has grabbed the device first. Try to
     load module yealink before any other usb hid driver. Please see the
     instructions provided by your distribution on module configuration.
-- 
2.54.0

Re: [PATCH v3] Input: yealink.rst: Fix typos and wording

Posted by Randy Dunlap 2 weeks, 5 days ago

Hi,

On 9/6/26 2:55 AM, Manuel Ebner wrote:
> Improve readability.
> 
> Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
> CC: Randy Dunlap <rdunlap@infradead.org>
> ---
> [v3]
>  fix wording
>  droped white-space fixes
> 
> [v2]
>  add ']' instead of remove '[' as randy suggested
>  fix a couple more issues in the file
> 
> [v1]
>  https://lore.kernel.org/all/20260904121026.759218-3-manuelebnerli@mailbox.org/
> ---
>  Documentation/input/devices/yealink.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/input/devices/yealink.rst b/Documentation/input/devices/yealink.rst
> index bb5a1aafe..de1460b6b 100644
> --- a/Documentation/input/devices/yealink.rst
> +++ b/Documentation/input/devices/yealink.rst
> @@ -120,9 +120,10 @@ Reading /sys/../lineX will return the format string with its current value.
>  Writing to /sys/../lineX will set the corresponding LCD line.
>  
>   - Excess characters are ignored.
> - - If less characters are written than allowed, the remaining digits are
> + - If fewer characters than allowed are written, the remaining digits are
>     unchanged.
> - - The tab '\t'and '\n' char does not overwrite the original content.
> + - The tab '\t' and newline '\n' characters do not overwrite the original
> +   content.

In looking at the produced html, the backslashes above are missing.
This fixes it, although I don't know if it's the best or only fix:

 - The tab '\\t' and newline '\\n' characters do not overwrite the original
   content.

With that fixed:
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

>   - Writing a space to an icon will always hide its content.
>  
>    Example::
> @@ -205,7 +206,7 @@ Troubleshooting
>  :Q: Module yealink compiled and installed without any problem but phone
>      is not initialized and does not react to any actions.
>  :A: If you see something like:
> -    hiddev0: USB HID v1.00 Device [Yealink Network Technology Ltd. VOIP USB Phone
> +    hiddev0: USB HID v1.00 Device [Yealink Network Technology Ltd. VOIP USB Phone]
>      in dmesg, it means that the hid driver has grabbed the device first. Try to
>      load module yealink before any other usb hid driver. Please see the
>      instructions provided by your distribution on module configuration.

-- 
~Randy

Re: [PATCH v3] Input: yealink.rst: Fix typos and wording

Posted by Randy Dunlap 2 weeks, 4 days ago


On 9/6/26 9:33 AM, Randy Dunlap wrote:
> Hi,
> 
> On 9/6/26 2:55 AM, Manuel Ebner wrote:
>> Improve readability.
>>
>> Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
>> CC: Randy Dunlap <rdunlap@infradead.org>
>> ---
>> [v3]
>>  fix wording
>>  droped white-space fixes
>>
>> [v2]
>>  add ']' instead of remove '[' as randy suggested
>>  fix a couple more issues in the file
>>
>> [v1]
>>  https://lore.kernel.org/all/20260904121026.759218-3-manuelebnerli@mailbox.org/
>> ---
>>  Documentation/input/devices/yealink.rst | 7 ++++---
>>  1 file changed, 4 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/input/devices/yealink.rst b/Documentation/input/devices/yealink.rst
>> index bb5a1aafe..de1460b6b 100644
>> --- a/Documentation/input/devices/yealink.rst
>> +++ b/Documentation/input/devices/yealink.rst
>> @@ -120,9 +120,10 @@ Reading /sys/../lineX will return the format string with its current value.
>>  Writing to /sys/../lineX will set the corresponding LCD line.
>>  
>>   - Excess characters are ignored.
>> - - If less characters are written than allowed, the remaining digits are
>> + - If fewer characters than allowed are written, the remaining digits are
>>     unchanged.
>> - - The tab '\t'and '\n' char does not overwrite the original content.
>> + - The tab '\t' and newline '\n' characters do not overwrite the original
>> +   content.
> 
> In looking at the produced html, the backslashes above are missing.
> This fixes it, although I don't know if it's the best or only fix:
> 
>  - The tab '\\t' and newline '\\n' characters do not overwrite the original
>    content.

I think this would be better:

 - The tab ``\t`` and newline ``\n`` characters do not overwrite the original
   content.

> 
> With that fixed:
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>
> 
> Thanks.
> 
>>   - Writing a space to an icon will always hide its content.
>>  
>>    Example::
>> @@ -205,7 +206,7 @@ Troubleshooting
>>  :Q: Module yealink compiled and installed without any problem but phone
>>      is not initialized and does not react to any actions.
>>  :A: If you see something like:
>> -    hiddev0: USB HID v1.00 Device [Yealink Network Technology Ltd. VOIP USB Phone
>> +    hiddev0: USB HID v1.00 Device [Yealink Network Technology Ltd. VOIP USB Phone]
>>      in dmesg, it means that the hid driver has grabbed the device first. Try to
>>      load module yealink before any other usb hid driver. Please see the
>>      instructions provided by your distribution on module configuration.
> 

-- 
~Randy