docs: document zero bits in index "mode"
Documentation/gitformat-index.txt describes the "mode" as 32 bits, but only documents 16 bits. Document the missing 16 bits and specify that 'unused' bits must be zero. Signed-off-by: Glen Choo <chooglen@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Glen Choo committed
Feb 1, 2023 at 10:40 UTC
3a2ebaebc76b302629a5789696d67a0ce2c4378e
1 file changed
+3
-1
Documentation/gitformat-index.txt
+3
-1
@@ -83,11 +83,13 @@ Git index format
83
84
32-bit mode, split into (high to low bits)
85
86
+ 16-bit unused, must be zero
87
+
88
4-bit object type
89
valid values in binary are 1000 (regular file), 1010 (symbolic link)
90
and 1110 (gitlink)
91
90
- 3-bit unused
92
+ 3-bit unused, must be zero
93
94
9-bit unix permission. Only 0755 and 0644 are valid for regular files.
95
Symbolic links and gitlinks have value 0 in this field.