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

Re: [PATCH] index-format.txt: remove outdated list of supported extensions

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Jul 18, 2022, 13:35 UTC
Message-ID
<220718.86cze2y22q.gmgdl@evledraar.gmail.com>
In-Reply-To
<20220718085640.7395-1-szeder.dev@gmail.com>
On Mon, Jul 18 2022, SZEDER Gábor wrote:
Show 20 quoted lines
> The first section of 'Documentation/technical/index-format.txt'
> mentions that "Git currently supports cache tree and resolve undo
> extensions", but then goes on, and in the "Extensions" section
> describes not only these two, but six other extensions [1].
>
> Remove this sentence, as it's misleading about the status of all those
> other extensions.
>
> Alternatively we could keep that sentence and update the list of
> extensions, but that might well lead to a recurring issue, because
> apparently this list is never updated when a new index extension is
> added.
>
> [1] Split index, untracked cache, FS monitor cache, end of index
>     entry, index entry offset table and sparse directory entries.
>
> Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
> ---
>  Documentation/technical/index-format.txt | 2 --
>  1 file changed, 2 deletions(-)

Note that there's a conflict with my series to move this to gitformat-index(5), although the conflict is easily solved: https://lore.kernel.org/git/patch-v4-6.8-858ce9c6999-20220718T132911Z-avarab@gmail.com/

Show 12 quoted lines
> diff --git a/Documentation/technical/index-format.txt b/Documentation/technical/index-format.txt
> index 65da0daaa5..f691c20ab0 100644
> --- a/Documentation/technical/index-format.txt
> +++ b/Documentation/technical/index-format.txt
> @@ -26,8 +26,6 @@ Git index format
>       Extensions are identified by signature. Optional extensions can
>       be ignored if Git does not understand them.
>  
> -     Git currently supports cache tree and resolve undo extensions.
> -
>       4-byte extension signature. If the first byte is 'A'..'Z' the
>       extension is optional and can be ignored.

I wonder if we should instead say : git currently supports various index extensions, see <asciidoc syntax to link to section below>.

Previous: SZEDER GáborNext: Junio C Hamano
Message 2 of 3 in “index-format.txt: remove outdated list of supported extensions”
  1. index-format.txt: remove outdated list of supported extensionsSZEDER Gábor, Jul 18, 2022
  2. Ævar Arnfjörð BjarmasonJul 18, 2022
  3. Junio C HamanoJul 18, 2022

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.