Commit 6356f18f authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Jonathan Corbet
Browse files

Align git commit ID abbreviation guidelines and checks 



The guidelines for git commit ID abbreviation are inconsistent: some
places state to use 12 characters exactly, while other places recommend
12 characters or more.  The same issue is present in the checkpatch.pl
script.

E.g. Documentation/dev-tools/checkpatch.rst says:

  **GIT_COMMIT_ID**
    The proper way to reference a commit id is:
    commit <12+ chars of sha1> ("<title line>")

However, scripts/checkpatch.pl has two different checks: one warning
check accepting 12 characters exactly:

    # Check Fixes: styles is correct
    Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")'

and a second error check accepting 12-40 characters:

    # Check for git id commit length and improperly formed commit descriptions
    # A correctly formed commit description is:
    #    commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
    Please use git commit description style 'commit <12+ chars of sha1>

Hence patches containing commit IDs with more than 12 characters are
flagged by checkpatch, and sometimes rejected by maintainers or
reviewers.  This is becoming more important with the growth of the
repository, as git may decide to use more characters in case of local
conflicts.

Fix this by settling on at least 12 characters, in both the
documentation and in the checkpatch.pl script.

Fixes: bd17e036 ("checkpatch: warn for non-standard fixes tag style")
Signed-off-by: default avatarGeert Uytterhoeven <geert+renesas@glider.be>
Link: https://lore.kernel.org/r/1c244040bf6ce304656e31036e5178b4b9dfb719.1733421037.git.geert+renesas@glider.be


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 3f997cbf

Documentation/process/maintainer-tip.rst

+1 −1
Original line number Diff line number Diff line
@@ -270,7 +270,7 @@ Ordering of commit tags 
To have a uniform view of the commit tags, the tip maintainers use the

following tag ordering scheme:



 - Fixes: 12char-SHA1 ("sub/sys: Original subject line")

 - Fixes: 12+char-SHA1 ("sub/sys: Original subject line")



   A Fixes tag should be added even for changes which do not need to be

   backported to stable kernels, i.e. when addressing a recently introduced

Documentation/process/submitting-patches.rst

+4 −4
Original line number Diff line number Diff line
@@ -143,10 +143,10 @@ also track such tags and take certain actions. Private bug trackers and 
invalid URLs are forbidden.



If your patch fixes a bug in a specific commit, e.g. you found an issue using

``git bisect``, please use the 'Fixes:' tag with the first 12 characters of

the SHA-1 ID, and the one line summary.  Do not split the tag across multiple

lines, tags are exempt from the "wrap at 75 columns" rule in order to simplify

parsing scripts.  For example::

``git bisect``, please use the 'Fixes:' tag with at least the first 12

characters of the SHA-1 ID, and the one line summary.  Do not split the tag

across multiple lines, tags are exempt from the "wrap at 75 columns" rule in

order to simplify parsing scripts.  For example::



	Fixes: 54a4f0239f2e ("KVM: MMU: make kvm_mmu_zap_page() return the number of pages it actually freed")

scripts/checkpatch.pl

+2 −2
Original line number Diff line number Diff line
@@ -3230,7 +3230,7 @@ sub process { 
			my $tag_case = not ($tag eq "Fixes:");

			my $tag_space = not ($line =~ /^fixes:? [0-9a-f]{5,40} ($balanced_parens)/i);



			my $id_length = not ($orig_commit =~ /^[0-9a-f]{12}$/i);

			my $id_length = not ($orig_commit =~ /^[0-9a-f]{12,40}$/i);

			my $id_case = not ($orig_commit !~ /[A-F]/);



			my $id = "0123456789ab";
@@ -3240,7 +3240,7 @@ sub process { 
			if ($ctitle ne $title || $tag_case || $tag_space ||

			    $id_length || $id_case || !$title_has_quotes) {

				if (WARN("BAD_FIXES_TAG",

				     "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) &&

				     "Please use correct Fixes: style 'Fixes: <12+ chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) &&

				    $fix) {

					$fixed[$fixlinenr] = "Fixes: $cid (\"$ctitle\")";

				}