[v2,38/39] docs: add documentation for extensions.objectFormat

Commit Message

brian m. carlson July 13, 2020, 2:49 a.m. UTC

Document the extensions.objectFormat config setting.  Warn users not to
modify it themselves.

Signed-off-by: brian m. carlson <[e-mail]>
---
 Documentation/config.txt            | 2 ++
 Documentation/config/extensions.txt | 9 +++++++++
 2 files changed, 11 insertions(+)
 create mode 100644 Documentation/config/extensions.txt

Patch

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ef0768b91a..3042d80978 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -348,6 +348,8 @@  include::config/diff.txt[]
 
 include::config/difftool.txt[]
 
+include::config/extensions.txt[]
+
 include::config/fastimport.txt[]
 
 include::config/feature.txt[]
diff --git a/Documentation/config/extensions.txt b/Documentation/config/extensions.txt
new file mode 100644
index 0000000000..8baf23298c
--- /dev/null
+++ b/Documentation/config/extensions.txt
@@ -0,0 +1,9 @@ 
+extensions.objectFormat::
+	Specify the hash algorithm to use.  The acceptable values are `sha1` and
+	`sha256`.  If not specified, `sha1` is assumed.  As with other keys under
+	the `extensions` hierarchy, this value is ignored and has no effect unless
+	`core.repositoryformatversion` is 1.
++
+Note that this setting should only be set by linkgit:git-init[1] or
+linkgit:git-clone[1].  Trying to change it after initialization will not
+work and will produce hard-to-diagnose issues.