[37/38] docs: add documentation for extensions.objectFormat
diff mbox series

Message ID 20200710024728.3100527-38-sandals@crustytoothpaste.net
State New
Headers show
Series
  • SHA-256, part 3/3
Related show

Commit Message

brian m. carlson July 10, 2020, 2:47 a.m. UTC
Document the extensions.objectFormat config setting.  Warn users not to
modify it themselves.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
---
 Documentation/config.txt            | 2 ++
 Documentation/config/extensions.txt | 7 +++++++
 2 files changed, 9 insertions(+)
 create mode 100644 Documentation/config/extensions.txt

Comments

Martin Ă…gren July 10, 2020, 8:21 p.m. UTC | #1
On Fri, 10 Jul 2020 at 04:50, brian m. carlson
<sandals@crustytoothpaste.net> wrote:
> diff --git a/Documentation/config/extensions.txt b/Documentation/config/extensions.txt
> new file mode 100644
> index 0000000000..70d69cf9ab
> --- /dev/null
> +++ b/Documentation/config/extensions.txt
> @@ -0,0 +1,7 @@
> +extensions.objectFormat::
> +       Specify the hash algorithm to use.  The acceptable values are `sha1`
> +       and (if supported) `sha256`.  If not specified, `sha1` is assumed.
> ++
> +Note that this setting should only by 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.

s/by set/be set/

Martin

Patch
diff mbox series

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..70d69cf9ab
--- /dev/null
+++ b/Documentation/config/extensions.txt
@@ -0,0 +1,7 @@ 
+extensions.objectFormat::
+	Specify the hash algorithm to use.  The acceptable values are `sha1`
+	and (if supported) `sha256`.  If not specified, `sha1` is assumed.
++
+Note that this setting should only by 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.