From: Eric Sunshine <sunshine@sunshineco.com>
Date: Sun, 26 Jul 2020 23:56:57 GMT
Subject: Re: [PATCH v4 38/39] docs: add documentation for extensions.objectFormat
Message-ID: <CAPig+cRQN_JWEd-EZchDaa-BSeDynx_+b+h9SJ1o6MFS3DQ+JA@mail.gmail.com>
In-Reply-To: <20200726195424.626969-39-sandals@crustytoothpaste.net>

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.