Patchwork D6449: help: clarify overlap of revlog header and first revlog entry

mail settings
Submitter phabricator
Date May 28, 2019, 6:39 p.m.
Message ID <>
Download mbox | patch
Permalink /patch/40253/
State Superseded
Headers show


phabricator - May 28, 2019, 6:39 p.m.
ngoldbaum created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

  rHG Mercurial




To: ngoldbaum, #hg-reviewers
Cc: mercurial-devel


diff --git a/mercurial/help/internals/revlogs.txt b/mercurial/help/internals/revlogs.txt
--- a/mercurial/help/internals/revlogs.txt
+++ b/mercurial/help/internals/revlogs.txt
@@ -28,8 +28,8 @@ 
 A revlog begins with a 32-bit big endian integer holding version info
-and feature flags. This integer is shared with the first revision
+and feature flags. This integer overlaps with the first four bytes of
+the first revision entry.
 This integer is logically divided into 2 16-bit shorts. The least
 significant half of the integer is the format/version short. The other
@@ -78,10 +78,10 @@ 
 00 03 00 01
    v1 + inline + generaldelta
-Following the 32-bit header is the remainder of the first index entry.
-Following that are remaining *index* data. Inlined revision data is
-possibly located between index entries. More on this layout is described
+Following the 32-bit header is the remaining 60 bytes of the first index
+entry. Following that are additional *index* entries. Inlined revision
+data is possibly located between index entries. More on the this inlined
+layout is described below.
 Version 1 Format
@@ -149,8 +149,12 @@ 
 separate byte container. The offsets from bytes 0-5 and the compressed
 length from bytes 8-11 define how to access this data.
-The first 4 bytes of the revlog are shared between the revlog header
-and the 6 byte absolute offset field from the first revlog entry.
+The 6 byte absolute offset field from the first revlog entry overlaps
+with the revlog header. That is, the first 6 bytes of the first revlog
+entry can be split into four bytes containing the header for the revlog
+file and an additional two bytes containing the offset for the first
+entry. Since this is the offset from the beginning of the file for the
+first revision entry, the two bytes will always be set to zero.
 Version 2 Format