Documentation: distinguish between ref and offset deltas in pack-format
eb32d236 introduced the OBJ_OFS_DELTA object that uses a relative offset to identify the base object instead of the 20-byte SHA1 reference. The pack file documentation only mentions the SHA1 based reference in its description of the deltified object entry. Update the pack format documentation to clarify that the deltified object representation refers to its base using either a relative negative offset or the absolute SHA1 identifier. Signed-off-by: Stefan Saasen <ssaasen@atlassian.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stefan Saasen committed
Apr 12, 2013 at 15:56 UTC
06cb843fea195ea99391c4daf8018a13ec99c75e
1 file changed
+3
-1
Documentation/technical/pack-format.txt
+3
-1
@@ -26,7 +26,9 @@ GIT pack format
26
27
(deltified representation)
28
n-byte type and length (3-bit type, (n-1)*7+4-bit length)
29
- 20-byte base object name
29
+ 20-byte base object name if OBJ_REF_DELTA or a negative relative
30
+ offset from the delta object's position in the pack if this
31
+ is an OBJ_OFS_DELTA object
32
compressed delta data
33
34
Observation: length of each object is encoded in a variable