Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <9717acd3dd00d607da718da251a0bba6b376da96.camel@perches.com>
Subject: Re: [PATCH] checkpatch: check for missing Fixes tags
From:   Joe Perches <joe@perches.com>
To:     Dan Carpenter <dan.carpenter@linaro.org>,
        Andy Whitcroft <apw@canonical.com>,
        Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        linux-kernel@vger.kernel.org
Cc:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Arnd Bergmann <arnd@arndb.de>,
        Kees Cook <keescook@chromium.org>,
        Sasha Levin <sashal@kernel.org>, Tom Gall <tom.gall@linaro.org>
Date:   Tue, 06 Jun 2023 08:11:03 -0700
In-Reply-To: <ZH7uo6ph8nhidxcV@moroto>
References: <ZH7uo6ph8nhidxcV@moroto>
Content-Type: text/plain; charset="ISO-8859-1"
Content-Transfer-Encoding: 8BIT
User-Agent: Evolution 3.48.2 (3.48.2-1.fc38) 
MIME-Version: 1.0
Precedence: bulk

On Tue, 2023-06-06 at 11:30 +0300, Dan Carpenter wrote:
> This check looks for common words that probably indicate a patch
> is a fix.  For now the regex is:
> 
> 	(BUG: KASAN|Call Trace:|syzkaller|stable\@)

Seems sensible.  Style notes:


> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -3186,6 +3192,12 @@ sub process {
>  			}
>  		}
>  
> +# These indicate a bug fix
> +		if (!$in_header_lines &&
> +			$line =~ /(BUG: KASAN|Call Trace:|syzkaller|stable\@)/) {
> +			$needs_fixes_tag++;

Align to open parenthesis please.
Maybe add "Closes:"
This should not check any actual patch lines.

So this should likely use

		if (!$in_header_lines && !$is_patch &&
		    $line =~ /\b(?:BUG: KASAN|Call Trace:|Closes:|syzkaller|stable\@)/) {

There's no use of $needs_fixes_tag as something
other than a bool, so please just use

			$needs_fixes_tag = 1;

> @@ -3198,6 +3210,7 @@ sub process {
>  			my $id_length = 1;
>  			my $id_case = 1;
>  			my $title_has_quotes = 0;
> +			$fixes_tag++;

			$fixes_tag = 1;

here too

> @@ -7636,6 +7649,12 @@ sub process {
>  		ERROR("NOT_UNIFIED_DIFF",
>  		      "Does not appear to be a unified-diff format patch\n");
>  	}
> +	if ($is_patch && $has_commit_log && $chk_fixes_tag) {
> +		if ($needs_fixes_tag && $fixes_tag == 0) {

		if ($needs_fixes_tag && !$fixes_tag) {

> +			ERROR("MISSING_FIXES_TAG",
> +			"This looks like a fix but there is no Fixes: tag\n");

Alignment to open parenthesis and likely WARN not ERROR