* gitformat-index.txt has a gap in the "mode" description?
@ 2023-01-31 16:43 Glen Choo
2023-01-31 19:26 ` Junio C Hamano
0 siblings, 1 reply; 2+ messages in thread
From: Glen Choo @ 2023-01-31 16:43 UTC (permalink / raw)
To: git
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
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: gitformat-index.txt has a gap in the "mode" description?
2023-01-31 16:43 gitformat-index.txt has a gap in the "mode" description? Glen Choo
@ 2023-01-31 19:26 ` Junio C Hamano
0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2023-01-31 19:26 UTC (permalink / raw)
To: Glen Choo; +Cc: git
Glen Choo <chooglen@google.com> writes:
> 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.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-01-31 19:26 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-01-31 16:43 gitformat-index.txt has a gap in the "mode" description? Glen Choo
2023-01-31 19:26 ` Junio C Hamano
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).