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

Re: gitformat-index.txt has a gap in the "mode" description?

From
Junio C Hamano <gitster@pobox.com>
Date
Jan 31, 2023, 19:26 UTC
Message-ID
<xmqqmt5yy08d.fsf@gitster.g>
In-Reply-To
<kl6l357qy7r2.fsf@chooglen-macbookpro.roam.corp.google.com>
Glen Choo <chooglen@google.com> writes:
Show 7 quoted lines
> According to gitformat-index.txt [1], "mode" is 32 bits, but we've only
> documented 16 bits. I tried poking around read-cache.c, and my
> impression is that other 16 are just NUL. If so, it would be worth
> documenting that they're unused, especially since we documented
> unused bits right in that section.
>
> [1] https://github.com/git/git/blob/master/Documentation/gitformat-index.txt#L84

Good thinking. The existing explanation starts with "32-bit mode, split into (high to low bits)", followed by "4-bit object type", as if the "4-bit object type" occupies bits 29-32, which is not quite what we want to say.

By the way, we should avoid saying "unused" but be more explicit and say "must be zero". The latter has no ambiguity but the former can be misinterpreted to allow any garbage.

Thanks.
Previous: Glen Choo
Message 2 of 2 in “gitformat-index.txt has a gap in the "mode" description?”
  1. Glen ChooJan 31, 2023
  2. Junio C HamanoJan 31, 2023

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.