From: "brian m. carlson" <sandals@crustytoothpaste•net>
To: <git@vger•kernel.org>
Cc: Junio C Hamano <gitster@pobox•com>, Patrick Steinhardt <ps@pks•im>
Subject: [PATCH 0/4] Fix doc default hash algorithm in WITH_BREAKING_CHANGES mode
Date: Tue, 2 Dec 2025 01:46:01 +0000 [thread overview]
Message-ID: <20251202014605.52110-1-sandals@crustytoothpaste.net> (raw)
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.
brian m. carlson (4):
docs: update git hash algorithm for breaking changes mode
docs: update index-pack hash algorithm for breaking changes mode
docs: update init hash algorithm for breaking changes mode
docs: update show-index hash algorithm for breaking changes mode
Documentation/git-index-pack.adoc | 14 +++++++++++---
Documentation/git-init.adoc | 8 +++++++-
Documentation/git-show-index.adoc | 14 +++++++++++---
Documentation/git.adoc | 8 +++++++-
4 files changed, 36 insertions(+), 8 deletions(-)
next reply other threads:[~2025-12-02 1:46 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-02 1:46 brian m. carlson [this message]
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
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=20251202014605.52110-1-sandals@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