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

[Jonathan Corbet]

Geert Uytterhoeven <geert+renesas@xxxxxxxxx> 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@xxxxxxxxx>
> ---
> 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