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 3/4] docs: update init hash algorithm for breaking changes mode
Date: Tue, 2 Dec 2025 01:46:04 +0000 [thread overview]
Message-ID: <20251202014605.52110-4-sandals@crustytoothpaste.net> (raw)
In-Reply-To: <20251202014605.52110-1-sandals@crustytoothpaste.net>
When compiled with WITH_BREAKING_CHANGES, the default hash algorithm
switches to SHA-256, but the documentation doesn't reflect this. Update
the init manual page to reflect the correct algorithm in this case.
Be sure to conditionalize only full sentences to aid in localization.
Signed-off-by: brian m. carlson <sandals@crustytoothpaste•net>
---
Documentation/git-init.adoc | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-init.adoc b/Documentation/git-init.adoc
index bab99b9b47..17dfef4654 100644
--- a/Documentation/git-init.adoc
+++ b/Documentation/git-init.adoc
@@ -53,7 +53,13 @@ current working directory.
`--object-format=<format>`::
Specify the given object _<format>_ (hash algorithm) for the repository. The valid
-values are `sha1` and (if enabled) `sha256`. `sha1` is the default.
+values are `sha1` and (if enabled) `sha256`.
+ifndef::with-breaking-changes[]
+ `sha1` is the default.
+endif::with-breaking-changes[]
+ifdef::with-breaking-changes[]
+ `sha256` is the default.
+endif::with-breaking-changes[]
+
include::object-format-disclaimer.adoc[]
next prev parent 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 [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 ` brian m. carlson [this message]
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-4-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