[PATCH] checkpatch: Introduce check for format of Fixes line in commit log

[PATCH] checkpatch: Introduce check for format of Fixes line in commit log

[Parav Pandit]

This patch introduces a format check for 'Fixes' line in commit log
for 12 characters commit id and format for Fixes as ("...").

Its created against linux-rdma Doug's tree [1].

[1] git://git.kernel.org/pub/scm/linux/kernel/git/dledford/rdma.git

Signed-off-by: Parav Pandit <parav@mellanox.com>
Signed-off-by: Brad Erickson <bradley@mellanox.com>
---
 scripts/checkpatch.pl | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index dd2c262..7d933e4 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2548,6 +2548,14 @@ sub process {
 			      "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
 		}
 
+# Check for incorrect format for Fixes line in commit log
+		if ($in_commit_log && $line =~ /^\s*Fixes:/i) {
+			if ($line !~ /^\s*Fixes: [a-z0-9]{12} \(\".*?\"\)$/i) {
+				ERROR("FIXES_FORMAT",
+				      "Follow format of Fixes: <12 characters commit id> (\"...\")\n" . $herecurr);
+			}
+		}
+
 # Check if the commit log is in a possible stack dump
 		if ($in_commit_log && !$commit_log_possible_stack_dump &&
 		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
-- 
1.8.3.1

RE: [PATCH] checkpatch: Introduce check for format of Fixes line in commit log

[Parav Pandit]

Hi Joe,

> -----Original Message-----
> From: linux-rdma-owner@vger.kernel.org [mailto:linux-rdma-
> owner@vger.kernel.org] On Behalf Of Parav Pandit
> Sent: Tuesday, October 10, 2017 5:44 PM
> To: joe@perches.com; apw@canonical.com
> Cc: linux-kernel@vger.kernel.org; linux-rdma@vger.kernel.org; Parav Pandit
> <parav@mellanox.com>; Brad Erickson <bradley@mellanox.com>
> Subject: [PATCH] checkpatch: Introduce check for format of Fixes line in commit
> log
> 
> This patch introduces a format check for 'Fixes' line in commit log for 12
> characters commit id and format for Fixes as ("...").
> 
> Its created against linux-rdma Doug's tree [1].
> 
> [1] git://git.kernel.org/pub/scm/linux/kernel/git/dledford/rdma.git
> 
> Signed-off-by: Parav Pandit <parav@mellanox.com>
> Signed-off-by: Brad Erickson <bradley@mellanox.com>
> ---
>  scripts/checkpatch.pl | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index
> dd2c262..7d933e4 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -2548,6 +2548,14 @@ sub process {
>  			      "Remove Gerrit Change-Id's before submitting
> upstream.\n" . $herecurr);
>  		}
> 
> +# Check for incorrect format for Fixes line in commit log
> +		if ($in_commit_log && $line =~ /^\s*Fixes:/i) {
> +			if ($line !~ /^\s*Fixes: [a-z0-9]{12} \(\".*?\"\)$/i) {
> +				ERROR("FIXES_FORMAT",
> +				      "Follow format of Fixes: <12 characters
> commit id> (\"...\")\n" . $herecurr);
> +			}
> +		}
> +
>  # Check if the commit log is in a possible stack dump
>  		if ($in_commit_log && !$commit_log_possible_stack_dump &&
>  		    ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
> --

Did you get a chance to review this minor improvement patch?
Does it look ok?
Can it be pushed to Linux-rdma tree?

Re: [PATCH] checkpatch: Introduce check for format of Fixes line in commit log

[Joe Perches]

On Thu, 2017-10-19 at 05:52 +0000, Parav Pandit wrote:
> Hi Joe,

Hello Parav

> > -----Original Message-----
> > From: linux-rdma-owner@vger.kernel.org [mailto:linux-rdma-
> > owner@vger.kernel.org] On Behalf Of Parav Pandit
> > Sent: Tuesday, October 10, 2017 5:44 PM
> > To: joe@perches.com; apw@canonical.com
> > Cc: linux-kernel@vger.kernel.org; linux-rdma@vger.kernel.org; Parav Pandit
> > <parav@mellanox.com>; Brad Erickson <bradley@mellanox.com>
> > Subject: [PATCH] checkpatch: Introduce check for format of Fixes line in commit
> > log
> > 
> > This patch introduces a format check for 'Fixes' line in commit log for 12
> > characters commit id and format for Fixes as ("...").

I think this doesn't handle case like:

Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=58735

RE: [PATCH] checkpatch: Introduce check for format of Fixes line in commit log

[Parav Pandit]

> -----Original Message-----
> From: Joe Perches [mailto:joe@perches.com]
> Sent: Thursday, October 19, 2017 12:57 AM
> To: Parav Pandit <parav@mellanox.com>; apw@canonical.com
> Cc: linux-kernel@vger.kernel.org; linux-rdma@vger.kernel.org; Brad Erickson
> <bradley@mellanox.com>
> Subject: Re: [PATCH] checkpatch: Introduce check for format of Fixes line in
> commit log
> 
> On Thu, 2017-10-19 at 05:52 +0000, Parav Pandit wrote:
> > Hi Joe,
> 
> Hello Parav
> 
> > > -----Original Message-----
> > > From: linux-rdma-owner@vger.kernel.org [mailto:linux-rdma-
> > > owner@vger.kernel.org] On Behalf Of Parav Pandit
> > > Sent: Tuesday, October 10, 2017 5:44 PM
> > > To: joe@perches.com; apw@canonical.com
> > > Cc: linux-kernel@vger.kernel.org; linux-rdma@vger.kernel.org; Parav
> > > Pandit <parav@mellanox.com>; Brad Erickson <bradley@mellanox.com>
> > > Subject: [PATCH] checkpatch: Introduce check for format of Fixes
> > > line in commit log
> > >
> > > This patch introduces a format check for 'Fixes' line in commit log
> > > for 12 characters commit id and format for Fixes as ("...").
> 
> I think this doesn't handle case like:
> 
> Fixes: https://bugs.freedesktop.org/show_bug.cgi?id=58735

I see such commits now. I will cover for such an additional format.
Fixes: <link>
Will send v1.