]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: sha256 is no longer experimental
authorAdam Majer <adamm@zombino.com>
Mon, 31 Jul 2023 13:42:02 +0000 (15:42 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 31 Jul 2023 16:11:04 +0000 (09:11 -0700)
Remove scary wording that basically stops people using sha256
repositories not because of interoperability issues with sha1
repositories, but from fear that their work will suddenly become
incompatible in some future version of git.

We should be clear that currently sha256 repositories will not work with
sha1 repositories but stop the scary words.

Signed-off-by: Adam Majer <adamm@zombino.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git.txt
Documentation/object-format-disclaimer.txt

index f0cafa22906d60822167c104e2c09a311ce25c30..11228956cd5ec400b498d7483b8a4f71ec433ab2 100644 (file)
@@ -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
 ~~~~~~~~~~~
index 4cb106f0d146e754e626e5d22a512ad9ab5524a3..e561e6668c9e59daa705e563068cd8b20aabd038 100644 (file)
@@ -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.