[v4,38/39] docs: add documentation for extensions.objectFormat
diff mbox series

Message ID 20200726195424.626969-39-sandals@crustytoothpaste.net
State New
Headers show
Series
  • [v4,01/39] t: make test-bloom initialize repository
Related show

Commit Message

brian m. carlson July 26, 2020, 7:54 p.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 | 8 ++++++++
 2 files changed, 10 insertions(+)
 create mode 100644 Documentation/config/extensions.txt

Comments

Eric Sunshine July 26, 2020, 11:56 p.m. UTC | #1
On Sun, Jul 26, 2020 at 3:56 PM brian m. carlson
<sandals@crustytoothpaste.net> wrote:
> Document the extensions.objectFormat config setting.  Warn users not to
> modify it themselves.
>
> Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
> ---
> diff --git a/Documentation/config/extensions.txt b/Documentation/config/extensions.txt
> @@ -0,0 +1,8 @@
> +extensions.objectFormat::
> +       Specify the hash algorithm to use.  The acceptable values are `sha1` and
> +       `sha256`.  If not specified, `sha1` is assumed.  It is an error to specify
> +       this key unless `core.repositoryformatversion` is 1.

Since this is user-facing, I think we'd want to write it in camelCase:

    this key unless `core.repositoryFormatVersion` is 1.

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..e97a78bdd6
--- /dev/null
+++ b/Documentation/config/extensions.txt
@@ -0,0 +1,8 @@ 
+extensions.objectFormat::
+	Specify the hash algorithm to use.  The acceptable values are `sha1` and
+	`sha256`.  If not specified, `sha1` is assumed.  It is an error to specify
+	this key 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.