revlog: add some comment in the header sections
authorPierre-Yves David <pierre-yves.david@octobus.net>
Mon, 05 Apr 2021 12:20:40 +0200
changeset 46855 aba724bf550e
parent 46854 6afb5ef1e776
child 46856 34e1fa4b548a
revlog: add some comment in the header sections We are about to add more content so let us organise the existing content first. Differential Revision: https://phab.mercurial-scm.org/D10302
mercurial/revlogutils/constants.py
--- a/mercurial/revlogutils/constants.py	Tue Apr 06 10:37:55 2021 +0200
+++ b/mercurial/revlogutils/constants.py	Mon Apr 05 12:20:40 2021 +0200
@@ -11,11 +11,15 @@
 
 from ..interfaces import repository
 
-# revlog header flags
+### main revlog header
+
+## revlog version
 REVLOGV0 = 0
 REVLOGV1 = 1
 # Dummy value until file format is finalized.
 REVLOGV2 = 0xDEAD
+
+##  global revlog header flags
 # Shared across v1 and v2.
 FLAG_INLINE_DATA = 1 << 16
 # Only used by v1, implied by v2.
@@ -26,6 +30,8 @@
 REVLOGV1_FLAGS = FLAG_INLINE_DATA | FLAG_GENERALDELTA
 REVLOGV2_FLAGS = FLAG_INLINE_DATA
 
+### individual entry
+
 # revlog index flags
 
 # For historical reasons, revlog's internal flags were exposed via the