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

diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index ac74d058e01d13830b276616dce25d5745b64699..af0c26232c1e775cf5f4d56ee67c07b6a73a9104 100644 (file)
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -100,6 +100,8 @@ OPTIONS
        value is set or outside a repository.
 +
 This option cannot be used with --stdin.
++
+include::object-format-disclaimer.txt[]
 
 NOTES
 -----

diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index ddfe265da5b6524f30d972bfea990bb2a89b5611..f35f70f13d0385e24ba2c0727e3720b4a068a048 100644 (file)
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -53,6 +53,8 @@ current working directory.
 
 Specify the given object format (hash algorithm) for the repository.  The valid
 values are 'sha1' and (if enabled) 'sha256'.  'sha1' is the default.
++
+include::object-format-disclaimer.txt[]
 
 --template=<template_directory>::
 

diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt
index 39b1d8eaa1456f60af07de2e30f0653f9d5efd64..e49318a5a0aec7f46c6d23dbff5afcb920fae236 100644 (file)
--- a/Documentation/git-show-index.txt
+++ b/Documentation/git-show-index.txt
@@ -44,6 +44,8 @@ OPTIONS
        valid values are 'sha1' and (if enabled) 'sha256'.  The default is the
        algorithm for the current repository (set by `extensions.objectFormat`), or
        'sha1' if no value is set or outside a repository..
++
+include::object-format-disclaimer.txt[]
 
 GIT
 ---

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 81349a84e73f76a8303dffa3d0d9a5bc71314f3e..2fc92586b52386c770bed28a11275c64eea3414a 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -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
        repositories will be set to this value. This value is currently
        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
 ~~~~~~~~~~~

diff --git a/Documentation/object-format-disclaimer.txt b/Documentation/object-format-disclaimer.txt
new file mode 100644 (file)
index 0000000..4cb106f
--- /dev/null
+++ b/Documentation/object-format-disclaimer.txt
@@ -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.