git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: "SZEDER Gábor" <szeder.dev@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] index-format.txt: remove outdated list of supported extensions
Date: Mon, 18 Jul 2022 15:35:24 +0200	[thread overview]
Message-ID: <220718.86cze2y22q.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <20220718085640.7395-1-szeder.dev@gmail.com>


On Mon, Jul 18 2022, SZEDER Gábor wrote:

> 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/

> 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>.

  reply	other threads:[~2022-07-18 13:37 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-18  8:56 [PATCH] index-format.txt: remove outdated list of supported extensions SZEDER Gábor
2022-07-18 13:35 ` Ævar Arnfjörð Bjarmason [this message]
2022-07-18 16:24 ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=220718.86cze2y22q.gmgdl@evledraar.gmail.com \
    --to=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=szeder.dev@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).