Merge branch 'ma/doc-sha-256-is-experimental'
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
This commit is contained in:
@ -100,6 +100,8 @@ OPTIONS
|
|||||||
value is set or outside a repository.
|
value is set or outside a repository.
|
||||||
+
|
+
|
||||||
This option cannot be used with --stdin.
|
This option cannot be used with --stdin.
|
||||||
|
+
|
||||||
|
include::object-format-disclaimer.txt[]
|
||||||
|
|
||||||
NOTES
|
NOTES
|
||||||
-----
|
-----
|
||||||
|
|||||||
@ -53,6 +53,8 @@ current working directory.
|
|||||||
|
|
||||||
Specify the given object format (hash algorithm) for the repository. The valid
|
Specify the given object format (hash algorithm) for the repository. The valid
|
||||||
values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
|
values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
|
||||||
|
+
|
||||||
|
include::object-format-disclaimer.txt[]
|
||||||
|
|
||||||
--template=<template_directory>::
|
--template=<template_directory>::
|
||||||
|
|
||||||
|
|||||||
@ -44,6 +44,8 @@ OPTIONS
|
|||||||
valid values are 'sha1' and (if enabled) 'sha256'. The default is the
|
valid values are 'sha1' and (if enabled) 'sha256'. The default is the
|
||||||
algorithm for the current repository (set by `extensions.objectFormat`), or
|
algorithm for the current repository (set by `extensions.objectFormat`), or
|
||||||
'sha1' if no value is set or outside a repository..
|
'sha1' if no value is set or outside a repository..
|
||||||
|
+
|
||||||
|
include::object-format-disclaimer.txt[]
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
---
|
---
|
||||||
|
|||||||
@ -504,7 +504,8 @@ double-quotes and respecting backslash escapes. E.g., the value
|
|||||||
If this variable is set, the default hash algorithm for new
|
If this variable is set, the default hash algorithm for new
|
||||||
repositories will be set to this value. This value is currently
|
repositories will be set to this value. This value is currently
|
||||||
ignored when cloning; the setting of the remote repository
|
ignored when cloning; the setting of the remote repository
|
||||||
is used instead. The default is "sha1".
|
is used instead. The default is "sha1". THIS VARIABLE IS
|
||||||
|
EXPERIMENTAL! See `--object-format` in linkgit:git-init[1].
|
||||||
|
|
||||||
Git Commits
|
Git Commits
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|||||||
6
Documentation/object-format-disclaimer.txt
Normal file
6
Documentation/object-format-disclaimer.txt
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
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.
|
||||||
Reference in New Issue
Block a user