Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <926a2f22e12bf989d46dc36c8779c50183bf4b7e.camel@perches.com>
Subject: Re: [PATCH] checkpatch: add fix option for GERRIT_CHANGE_ID
From:   Joe Perches <joe@perches.com>
To:     Aditya Srivastava <yashsri421@gmail.com>
Cc:     linux-kernel@vger.kernel.org,
        linux-kernel-mentees@lists.linuxfoundation.org,
        lukas.bulwahn@gmail.com, Andrew Morton <akpm@linux-foundation.org>
Date:   Fri, 30 Oct 2020 05:10:09 -0700
In-Reply-To: <20201030114447.24199-1-yashsri421@gmail.com>
References: <20201030114447.24199-1-yashsri421@gmail.com>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.38.1-1 
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

On Fri, 2020-10-30 at 17:14 +0530, Aditya Srivastava wrote:
> Currently, whenever a Gerrit Change-Id is present in a commit,
> checkpatch.pl warns to remove the Change-Id before submitting the patch.
> 
> E.g., running checkpatch on commit adc311a5bbf6 ("iwlwifi: bump FW
> API to 53 for 22000 series") reports this error:
> 
> ERROR: Remove Gerrit Change-Id's before submitting upstream
> Change-Id: I5725e46394f3f53c3069723fd513cc53c7df383d
> 
> Provide a simple fix option by simply deleting the indicated line.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -2852,8 +2852,11 @@ sub process {
> ?
> 
> ?# Check for Gerrit Change-Ids not in any patch context
> ?		if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
> -			ERROR("GERRIT_CHANGE_ID",
> -			      "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
> +			if (ERROR("GERRIT_CHANGE_ID",
> +			          "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) &&
> +			    $fix) {
> +                                fix_delete_line($fixlinenr, $rawline);
> +                        }
> ?		}

Seems sensible, thanks.

It might also be sensible if the line before and the line after
this change-id is also blank to remove one of those blank lines.

On second thought:

A quick check shows less than 20 of those in kernel git history
so it might not be too worthwhile.

Acked-by: Joe Perches <joe@perches.com>