aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/object-format-disclaimer.txt
diff options
context:
space:
mode:
authorAdam Majer <adamm@zombino.com>2023-07-31 15:42:02 +0200
committerJunio C Hamano <gitster@pobox.com>2023-07-31 09:11:04 -0700
commit8e42eb0e9ae44f65c360cd95ce28e84496ad8247 (patch)
tree7b2e42e0db87442e99454d34274d36e1b1ec6937 /Documentation/object-format-disclaimer.txt
parentcba07a324d2cda06dd7a7b35b4579f800de024aa (diff)
downloadgit-8e42eb0e9ae44f65c360cd95ce28e84496ad8247.tar.gz
doc: sha256 is no longer experimental
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>
Diffstat (limited to 'Documentation/object-format-disclaimer.txt')
-rw-r--r--Documentation/object-format-disclaimer.txt15
1 files changed, 9 insertions, 6 deletions
diff --git a/Documentation/object-format-disclaimer.txt b/Documentation/object-format-disclaimer.txt
index 4cb106f0d1..e561e6668c 100644
--- a/Documentation/object-format-disclaimer.txt
+++ b/Documentation/object-format-disclaimer.txt
@@ -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.