Skip to content

Commit e48d9c7

Browse files
committed
Merge branch 'am/doc-sha256'
Tone down the warning on SHA-256 repositories being an experimental curiosity. We do not have support for them to interoperate with traditional SHA-1 repositories, but at this point, we do not plan to make breaking changes to SHA-256 repositories and there is no longer need for such a strongly phrased warning. * am/doc-sha256: doc: sha256 is no longer experimental
2 parents dee27be + 8e42eb0 commit e48d9c7

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

Documentation/git.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -553,8 +553,8 @@ double-quotes and respecting backslash escapes. E.g., the value
553553
If this variable is set, the default hash algorithm for new
554554
repositories will be set to this value. This value is
555555
ignored when cloning and the setting of the remote repository
556-
is always used. The default is "sha1". THIS VARIABLE IS
557-
EXPERIMENTAL! See `--object-format` in linkgit:git-init[1].
556+
is always used. The default is "sha1".
557+
See `--object-format` in linkgit:git-init[1].
558558

559559
Git Commits
560560
~~~~~~~~~~~
Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
THIS OPTION IS EXPERIMENTAL! SHA-256 support is experimental and still
2-
in an early stage. A SHA-256 repository will in general not be able to
3-
share work with "regular" SHA-1 repositories. It should be assumed
4-
that, e.g., Git internal file formats in relation to SHA-256
5-
repositories may change in backwards-incompatible ways. Only use
6-
`--object-format=sha256` for testing purposes.
1+
Note: At present, there is no interoperability between SHA-256
2+
repositories and SHA-1 repositories.
3+
4+
Historically, we warned that SHA-256 repositories may later need
5+
backward incompatible changes when we introduce such interoperability
6+
features. Today, we only expect compatible changes. Furthermore, if such
7+
changes prove to be necessary, it can be expected that SHA-256 repositories
8+
created with today's Git will be usable by future versions of Git
9+
without data loss.

0 commit comments

Comments
 (0)