From: Jonathan Corbet <corbet@lwn.net>
To: "Geert Uytterhoeven" <geert+renesas@glider.be>,
"Dwaipayan Ray" <dwaipayanray1@gmail.com>,
"Lukas Bulwahn" <lukas.bulwahn@gmail.com>,
"Joe Perches" <joe@perches.com>,
"Thorsten Leemhuis" <linux@leemhuis.info>,
"Andy Whitcroft" <apw@canonical.com>,
"Niklas Söderlund" <niklas.soderlund@corigine.com>,
"Simon Horman" <horms@kernel.org>,
"Conor Dooley" <conor@kernel.org>,
"Miguel Ojeda" <miguel.ojeda.sandonis@gmail.com>,
"Linus Torvalds" <torvalds@linux-foundation.org>
Cc: Junio C Hamano <gitster@pobox.com>,
workflows@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Geert Uytterhoeven <geert+renesas@glider.be>
Subject: Re: [PATCH v2 1/2] Align git commit ID abbreviation guidelines and checks
Date: Mon, 30 Dec 2024 11:43:37 -0700 [thread overview]
Message-ID: <87msgd106e.fsf@trenco.lwn.net> (raw)
In-Reply-To: <1c244040bf6ce304656e31036e5178b4b9dfb719.1733421037.git.geert+renesas@glider.be>
Geert Uytterhoeven <geert+renesas@glider.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@glider.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
next prev parent reply other threads:[~2024-12-30 18:43 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-05 18:16 [PATCH v2 0/2] Align and increase " Geert Uytterhoeven
2024-12-05 18:16 ` [PATCH v2 1/2] Align " Geert Uytterhoeven
2024-12-30 18:43 ` Jonathan Corbet [this message]
2024-12-05 18:16 ` [PATCH v2 2/2] Increase minimum git commit ID abbreviation to 16 characters Geert Uytterhoeven
2024-12-05 19:19 ` Linus Torvalds
2024-12-13 19:41 ` Geert Uytterhoeven
2024-12-14 16:03 ` Matthew Wilcox
2024-12-14 16:31 ` Linus Torvalds
2024-12-18 23:36 ` [RFC] git-disambiguate: disambiguate shorthand git ids Sasha Levin
2024-12-19 1:41 ` Kees Cook
2024-12-19 20:35 ` Sasha Levin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87msgd106e.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=apw@canonical.com \
--cc=conor@kernel.org \
--cc=dwaipayanray1@gmail.com \
--cc=geert+renesas@glider.be \
--cc=gitster@pobox.com \
--cc=horms@kernel.org \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=lukas.bulwahn@gmail.com \
--cc=miguel.ojeda.sandonis@gmail.com \
--cc=niklas.soderlund@corigine.com \
--cc=torvalds@linux-foundation.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox