Skip to content

Commit

Permalink
Merge branch 'am/doc-sha256'
Browse files Browse the repository at this point in the history
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
  • Loading branch information
gitster committed Aug 7, 2023
2 parents dee27be + 8e42eb0 commit e48d9c7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
4 changes: 2 additions & 2 deletions Documentation/git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -553,8 +553,8 @@ double-quotes and respecting backslash escapes. E.g., the value
If this variable is set, the default hash algorithm for new
repositories will be set to this value. This value is
ignored when cloning and the setting of the remote repository
is always used. The default is "sha1". THIS VARIABLE IS
EXPERIMENTAL! See `--object-format` in linkgit:git-init[1].
is always used. The default is "sha1".
See `--object-format` in linkgit:git-init[1].

Git Commits
~~~~~~~~~~~
Expand Down
15 changes: 9 additions & 6 deletions Documentation/object-format-disclaimer.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
THIS OPTION IS EXPERIMENTAL! SHA-256 support is experimental and still
in an early stage. A SHA-256 repository will in general not be able to
share work with "regular" SHA-1 repositories. It should be assumed
that, e.g., Git internal file formats in relation to SHA-256
repositories may change in backwards-incompatible ways. Only use
`--object-format=sha256` for testing purposes.
Note: At present, there is no interoperability between SHA-256
repositories and SHA-1 repositories.

Historically, we warned that SHA-256 repositories may later need
backward incompatible changes when we introduce such interoperability
features. Today, we only expect compatible changes. Furthermore, if such
changes prove to be necessary, it can be expected that SHA-256 repositories
created with today's Git will be usable by future versions of Git
without data loss.

0 comments on commit e48d9c7

Please sign in to comment.