From: "brian m. carlson" <sandals@crustytoothpaste•net>
To: Patrick Steinhardt <ps@pks•im>
Cc: git@vger•kernel.org, Junio C Hamano <gitster@pobox•com>
Subject: Re: [PATCH 0/4] Fix doc default hash algorithm in WITH_BREAKING_CHANGES mode
Date: Tue, 2 Dec 2025 11:52:31 +0000 [thread overview]
Message-ID: <aS7S_zSpfk3r7jxh@fruit.crustytoothpaste.net> (raw)
In-Reply-To: <aS6g0Zjzd5OEd-mb@pks.im>
[-- Attachment #1: Type: text/plain, Size: 1281 bytes --]
On 2025-12-02 at 08:18:25, Patrick Steinhardt wrote:
> On Tue, Dec 02, 2025 at 01:46:01AM +0000, brian m. carlson wrote:
> > When WITH_BREAKING_CHANGES is defined, the default hash algorithm is not
> > SHA-1, but SHA-256. However, our documentation was never updated to
> > reflect this, and as a result, we end up misinforming users.
> >
> > This series fixes four places where we indicate a default hash algorithm
> > in our documentation such that they conditionally say that either SHA-1
> > or SHA-256 is the default, based on the the with-breaking-changes
> > attribute. This both improves accuracy now and also makes it less
> > likely that we'll forget to update these places when we hit Git 3.0.
>
> All of these look good to me. One alternative would be to introduce an
> attribute that we can then reference in the docs. The below patch shows
> how to do this with Asciidoc, but of course we'd also have to do this
> for Asciidoctor.
>
> I don't mind much which approach we use, but wanted to suggest this as
> an alternative.
I think it may be easier to set this in the Makefile and Meson config,
but I'll try to see if I can adopt a similar approach here and if so,
I'll send a v2.
--
brian m. carlson (they/them)
Toronto, Ontario, CA
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 262 bytes --]
prev parent reply other threads:[~2025-12-02 11:52 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-02 1:46 [PATCH 0/4] Fix doc default hash algorithm in WITH_BREAKING_CHANGES mode brian m. carlson
2025-12-02 1:46 ` [PATCH 1/4] docs: update git hash algorithm for breaking changes mode brian m. carlson
2025-12-02 7:04 ` Junio C Hamano
2025-12-02 1:46 ` [PATCH 2/4] docs: update index-pack " brian m. carlson
2025-12-02 1:46 ` [PATCH 3/4] docs: update init " brian m. carlson
2025-12-02 1:46 ` [PATCH 4/4] docs: update show-index " brian m. carlson
2025-12-02 8:18 ` [PATCH 0/4] Fix doc default hash algorithm in WITH_BREAKING_CHANGES mode Patrick Steinhardt
2025-12-02 11:52 ` brian m. carlson [this message]
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=aS7S_zSpfk3r7jxh@fruit.crustytoothpaste.net \
--to=sandals@crustytoothpaste$(echo .)net \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=ps@pks$(echo .)im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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