linux-kernel - Re: [PATCH] checkpatch: add judgment condition for Kconfig help test

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <c40ddfd4-5781-4382-a3f1-c18cbfb22b34@infradead.org>
Date:   Fri, 17 Nov 2023 18:26:32 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Cixi Geng <cixi.geng@...ux.dev>, apw@...onical.com, joe@...ches.co,
        dwaipayanray1@...il.com, lukas.bulwahn@...il.com,
        akpm@...ux-foundation.org
Cc:     linux-kernel@...r.kernel.org
Subject: Re: [PATCH] checkpatch: add judgment condition for Kconfig help test

Hi--

On 11/16/23 07:39, Cixi Geng wrote:
> From: Cixi Geng <cixi.geng1@...soc.com>
> 
> The has_help only counted the  situation which the patch file add
> a help line, when the config was renamed and  modify description,
> the has_help is zero for the "help" line not added.
> 
> here is one case:
>     the modify file: drivers/iio/adc/Kconfig  line(1047)
> 
>     -config SC27XX_ADC
>     +config SPRD_ADC
>      	tristate "Spreadtrum SC27xx series PMICs ADC"
>      	depends on MFD_SC27XX_PMIC || COMPILE_TEST
>     +	depends on ARCH_SPRD
>      	help
>     -	  Say yes here to build support for the integrated ADC inside the
>     -	  Spreadtrum SC27xx series PMICs.
>     +	  Say yes here to build support for the integrated ADC inside of the
>     +	  Spreadtrum SC27xx and UMPxx series PMICs.
> 
>      	  This driver can also be built as a module. If so, the module
>      	  will be called sc27xx_adc.

OK, I made those changes to that Kconfig file and ran checkpatch.
I didn't get any of the following checkpatch results.

Are you using a current version of checkpatch?

> the checkpatch result:
>     WARNING: please write a help paragraph that fully describes the config symbol
>     #23: FILE: drivers/iio/adc/Kconfig:1050:
>     +config SPRD_ADC
>     +	tristate "Spreadtrum's ADC PMICs driver"
>      	depends on MFD_SC27XX_PMIC || COMPILE_TEST
>     +	depends on ARCH_SPRD
>      	help
>     +	  Say yes here to build support for the integrated ADC inside of the
>     +	  Say yes here to build support for the integrated ADC inside of the
>     +	  Say yes here to build support for the integrated ADC inside of the
>     +	  Spreadtrum SC27xx and UMPxx series PMICs.
> 
>      	  This driver can also be built as a module. If so, the module
>      	  will be called sc27xx_adc.
> 
>     total: 0 errors, 1 warnings, 17 lines checked
> 
> Fixes: b8709bce9089 ("checkpatch: improve Kconfig help test")
> Signed-off-by: Cixi Geng <cixi.geng1@...soc.com>
> ---
>  scripts/checkpatch.pl | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 25fdb7fda112..402009d08505 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -3616,7 +3616,7 @@ sub process {
>  					$needs_help = 1;
>  					next;
>  				}
> -				if ($f =~ /^\+\s*help\s*$/) {
> +				if ($f =~ /^\+\s*help\s*$/ || $f =~ /^\s*help\s*$/) {
>  					$has_help = 1;
>  					next;
>  				}

-- 
~Randy