Skip to content

Commit 6ab1754

Browse files
committed
Merge branch 'ma/doc-sha-256-is-experimental' into seen
The recent addition of SHA-256 support is marked as experimental in the documentation. * ma/doc-sha-256-is-experimental: Documentation: mark `--object-format=sha256` as experimental
2 parents b79973c + 19d5bb5 commit 6ab1754

File tree

5 files changed

+14
-1
lines changed

5 files changed

+14
-1
lines changed

Documentation/git-index-pack.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ OPTIONS
100100
value is set or outside a repository.
101101
+
102102
This option cannot be used with --stdin.
103+
+
104+
include::object-format-disclaimer.txt[]
103105

104106
NOTES
105107
-----

Documentation/git-init.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ current working directory.
5353

5454
Specify the given object format (hash algorithm) for the repository. The valid
5555
values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
56+
+
57+
include::object-format-disclaimer.txt[]
5658

5759
--template=<template_directory>::
5860

Documentation/git-show-index.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ OPTIONS
4444
valid values are 'sha1' and (if enabled) 'sha256'. The default is the
4545
algorithm for the current repository (set by `extensions.objectFormat`), or
4646
'sha1' if no value is set or outside a repository..
47+
+
48+
include::object-format-disclaimer.txt[]
4749

4850
GIT
4951
---

Documentation/git.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,8 @@ double-quotes and respecting backslash escapes. E.g., the value
504504
If this variable is set, the default hash algorithm for new
505505
repositories will be set to this value. This value is currently
506506
ignored when cloning; the setting of the remote repository
507-
is used instead. The default is "sha1".
507+
is used instead. The default is "sha1". THIS VARIABLE IS
508+
EXPERIMENTAL! See `--object-format` in linkgit:git-init[1].
508509

509510
Git Commits
510511
~~~~~~~~~~~
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
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.

0 commit comments

Comments
 (0)