Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 19c146a6 authored by Joe Perches's avatar Joe Perches Committed by Linus Torvalds
Browse files

checkpatch: make sure a commit reference description uses parentheses 



The preferred style for a commit reference in a commit log is:

    commit <foo> ("<title line>")

A recent commit removed this check for parentheses.  Add it back.

Signed-off-by: default avatarJoe Perches <joe@perches.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent d2e025f3

scripts/checkpatch.pl

+5 −1
Original line number Diff line number Diff line
@@ -2191,6 +2191,7 @@ sub process { 
			my $case = 1;

			my $space = 1;

			my $hasdesc = 0;

			my $hasparens = 0;

			my $id = '0123456789ab';

			my $orig_desc = "commit description";

			my $description = "";
@@ -2201,10 +2202,12 @@ sub process { 
			$case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);

			if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {

				$orig_desc = $1;

				$hasparens = 1;

			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&

				 defined $rawlines[$linenr] &&

				 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {

				$orig_desc = $1;

				$hasparens = 1;

			} elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&

				 defined $rawlines[$linenr] &&

				 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
@@ -2212,12 +2215,13 @@ sub process { 
				$orig_desc = $1;

				$rawlines[$linenr] =~ /^\s*([^"]+)"\)/;

				$orig_desc .= " " . $1;

				$hasparens = 1;

			}



			($id, $description) = git_commit_info($orig_commit,

							      $id, $orig_desc);



			if ($short || $long || $space || $case || ($orig_desc ne $description)) {

			if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {

				ERROR("GIT_COMMIT_ID",

				      "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);

			}