git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] doc: consolidate extensions in git-config documentation

From
Taylor Blau <me@ttaylorr.com>
Date
Oct 22, 2024, 17:13 UTC
Message-ID
<ZxfdJs5+YbpHgpdv@nand.local>
In-Reply-To
<20241021-cleanup-extension-docs-v1-1-ab02cece3132@pm.me>
On Tue, Oct 22, 2024 at 12:08:49AM +0000, Caleb White wrote:
Show 22 quoted lines
> diff --git a/Documentation/config/extensions.txt b/Documentation/config/extensions.txt
> index f0a784447db09856639ec43b443681f13c17c966..5dc569d1c9c77c15e32441493289f9c9dd5e7f0b 100644
> --- a/Documentation/config/extensions.txt
> +++ b/Documentation/config/extensions.txt
> @@ -1,17 +1,13 @@
> -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.
> +extensions.*::
> +	Unless otherwise stated, is an error to specify an extension if
> +	`core.repositoryFormatVersion` is not `1`. See
> +	linkgit:gitrepository-layout[5].
>  +
> -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.
> -
> -extensions.compatObjectFormat::
> -
> +--
> +compatObjectFormat::

Should this be `extensions.compatObjectFormat` instead of `compatObjectFormat`? I think the latter will produce awkward headings when these all get merged into git-config(1).

Otherwise, looking good. Thanks for working on this!

Thanks, Taylor

Previous: Caleb WhiteNext: Caleb White
Message 2 of 3 in “doc: consolidate extensions in git-config documentation”
  1. doc: consolidate extensions in git-config documentationCaleb White, Oct 22, 2024
  2. Taylor BlauOct 22, 2024
  3. Caleb WhiteOct 22, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.