public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Cixi Geng <cixi.geng@linux.dev>
To: apw@canonical.com, joe@perches.co, dwaipayanray1@gmail.com,
	lukas.bulwahn@gmail.com, akpm@linux-foundation.org,
	rdunlap@infradead.org
Cc: linux-kernel@vger.kernel.org
Subject: [PATCH] checkpatch: add judgment condition for Kconfig help test
Date: Thu, 16 Nov 2023 23:39:04 +0800	[thread overview]
Message-ID: <20231116153904.15589-1-cixi.geng@linux.dev> (raw)

From: Cixi Geng <cixi.geng1@unisoc.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.

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@unisoc.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;
 				}
-- 
2.34.1


             reply	other threads:[~2023-11-16 15:47 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-16 15:39 Cixi Geng [this message]
2023-11-16 23:52 ` [PATCH] checkpatch: add judgment condition for Kconfig help test Bagas Sanjaya
2023-11-17 21:14   ` Andy Shevchenko
2023-11-17 23:19     ` Bagas Sanjaya
2023-11-18  2:26 ` Randy Dunlap
2023-11-18 14:37   ` Cixi Geng

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231116153904.15589-1-cixi.geng@linux.dev \
    --to=cixi.geng@linux.dev \
    --cc=akpm@linux-foundation.org \
    --cc=apw@canonical.com \
    --cc=dwaipayanray1@gmail.com \
    --cc=joe@perches.co \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox