linux-kernel - Re: [PATCH] staging: rts5208: Add more details to Kconfig help

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date: Thu, 18 Jan 2024 10:59:27 -0500
From: Jacob Lott <jklott.git@...il.com>
To: Greg KH <gregkh@...uxfoundation.org>
Cc: linux-staging@...ts.linux.dev, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] staging: rts5208: Add more details to Kconfig help


On 1/18/24 10:48 AM, Greg KH wrote:
> On Thu, Jan 18, 2024 at 10:40:44AM -0500, Jacob Lott wrote:
>> The current help text is short and triggers a
>> warning from checkpatch.pl.  This patch adds more
>> details to the help text which should provide better information
>> for whether or not to enable the driver.
> Please wrap your lines at 72 columns.
>
>> Signed-off-by: Jacob Lott <jklott.git@...il.com>
>> ---
>>   drivers/staging/rts5208/Kconfig | 10 +++++++---
>>   1 file changed, 7 insertions(+), 3 deletions(-)
>>
>> diff --git a/drivers/staging/rts5208/Kconfig b/drivers/staging/rts5208/Kconfig
>> index b864023d3ccb..76a083fbe401 100644
>> --- a/drivers/staging/rts5208/Kconfig
>> +++ b/drivers/staging/rts5208/Kconfig
>> @@ -3,7 +3,11 @@ config RTS5208
>>   	tristate "Realtek PCI-E Card Reader RTS5208/5288 support"
>>   	depends on PCI && SCSI
>>   	help
>> -	  Say Y here to include driver code to support the Realtek
>> -	  PCI-E card reader rts5208/rts5288.
>> +      Choose Y here to enable support for the Realtek PCI-E card reader RTS5208/5288.
> No tab?  Didn't checkpatch complain about this when you ran it on this
> patch?
>
>> +	  This driver facilitates communication between the Linux kernel and the Realtek
>> +	  PCI-E card reader.
>>   
>> -	  If this driver is compiled as a module, it will be named rts5208.
>> +	  If you opt to compile this driver as a module, it will be named rts5208. Selecting
>> +	  N will exclude this driver from the kernel build. Choose option Y if your system includes
>> +	  the Realtek PCI-E card reader rts5208/rts5288. When in doubt, it is generally safe
>> +	  to select N.
> Wrap your lines properly here at 80 columns.
>
> thanks,
>
> greg k-h
Checkpatch is not pointing out any issues when I run it:

/scripts/checkpatch.pl 
/tmp/0001-staging-rts5208-Add-more-details-to-Kconfig-help.pat
ch
total: 0 errors, 0 warnings, 0 checks, 14 lines checked

/tmp/0001-staging-rts5208-Add-more-details-to-Kconfig-help.patch has no 
obvious style problems and is ready for submission.

Does this indicate I need to set a configuration specifically for the 
checkpatch?