linux-kernel - Re: [PATCH v2 1/2] Align git commit ID abbreviation guidelines and checks

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87msgd106e.fsf@trenco.lwn.net>
Date: Mon, 30 Dec 2024 11:43:37 -0700
From: Jonathan Corbet <corbet@....net>
To: Geert Uytterhoeven <geert+renesas@...der.be>, Dwaipayan Ray
 <dwaipayanray1@...il.com>, Lukas Bulwahn <lukas.bulwahn@...il.com>, Joe
 Perches <joe@...ches.com>, Thorsten Leemhuis <linux@...mhuis.info>, Andy
 Whitcroft <apw@...onical.com>, Niklas Söderlund
 <niklas.soderlund@...igine.com>, Simon Horman <horms@...nel.org>, Conor
 Dooley <conor@...nel.org>, Miguel Ojeda <miguel.ojeda.sandonis@...il.com>,
 Linus Torvalds <torvalds@...ux-foundation.org>
Cc: Junio C Hamano <gitster@...ox.com>, workflows@...r.kernel.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Geert
 Uytterhoeven <geert+renesas@...der.be>
Subject: Re: [PATCH v2 1/2] Align git commit ID abbreviation guidelines and
 checks

Geert Uytterhoeven <geert+renesas@...der.be> writes:

> 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: bd17e036b495bebb ("checkpatch: warn for non-standard fixes tag style")
> Signed-off-by: Geert Uytterhoeven <geert+renesas@...der.be>
> ---
> v2:
>   - Rebase on top of commit 2f07b652384969f5 ("checkpatch: always parse
>     orig_commit in fixes tag") in v6.13-rc1,
>   - Update documentation, too.
> ---
>  Documentation/process/maintainer-tip.rst     | 2 +-
>  Documentation/process/submitting-patches.rst | 8 ++++----
>  scripts/checkpatch.pl                        | 4 ++--
>  3 files changed, 7 insertions(+), 7 deletions(-)

So, while the other patch in this series raised some eyebrows, nobody
has complained about this one.  Consistency and clarity are good, so
I've applied this one, thanks.

jon