( )⚙ D10302 revlog: add some comment in the header sections

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10302

revlog: add some comment in the header sections
ClosedPublic

Authored by marmoute on Apr 5 2021, 11:49 AM.

Details

Reviewers
Alphare
pulkit
Group Reviewers
hg-reviewers
Commits
rHGaba724bf550e: revlog: add some comment in the header sections
Summary

We are about to add more content so let us organise the existing content first.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

marmoute created this revision.Apr 5 2021, 11:49 AM
Alphare accepted this revision.Apr 8 2021, 5:48 AM
pulkit accepted this revision.Apr 8 2021, 5:59 AM
This revision is now accepted and ready to land.Apr 8 2021, 5:59 AM
marmoute added a commit: rHGaba724bf550e: revlog: add some comment in the header sections.Apr 8 2021, 6:56 AM
Closed by commit rHGaba724bf550e: revlog: add some comment in the header sections (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/revlogutils/constants.py (8 lines)

Diff 26649

mercurial/revlogutils/constants.py

# revlogdeltas.py - constant used for revlog logic # revlogdeltas.py - constant used for revlog logic
# #
# Copyright 2005-2007 Olivia Mackall <olivia@selenic.com> # Copyright 2005-2007 Olivia Mackall <olivia@selenic.com>
# Copyright 2018 Octobus <contact@octobus.net> # Copyright 2018 Octobus <contact@octobus.net>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
"""Helper class to compute deltas stored inside revlogs""" """Helper class to compute deltas stored inside revlogs"""
from __future__ import absolute_import from __future__ import absolute_import
from ..interfaces import repository from ..interfaces import repository
# revlog header flags ### main revlog header
## revlog version
REVLOGV0 = 0 REVLOGV0 = 0
REVLOGV1 = 1 REVLOGV1 = 1
# Dummy value until file format is finalized. # Dummy value until file format is finalized.
REVLOGV2 = 0xDEAD REVLOGV2 = 0xDEAD
## global revlog header flags
# Shared across v1 and v2. # Shared across v1 and v2.
FLAG_INLINE_DATA = 1 << 16 FLAG_INLINE_DATA = 1 << 16
# Only used by v1, implied by v2. # Only used by v1, implied by v2.
FLAG_GENERALDELTA = 1 << 17 FLAG_GENERALDELTA = 1 << 17
REVLOG_DEFAULT_FLAGS = FLAG_INLINE_DATA REVLOG_DEFAULT_FLAGS = FLAG_INLINE_DATA
REVLOG_DEFAULT_FORMAT = REVLOGV1 REVLOG_DEFAULT_FORMAT = REVLOGV1
REVLOG_DEFAULT_VERSION = REVLOG_DEFAULT_FORMAT | REVLOG_DEFAULT_FLAGS REVLOG_DEFAULT_VERSION = REVLOG_DEFAULT_FORMAT | REVLOG_DEFAULT_FLAGS
REVLOGV1_FLAGS = FLAG_INLINE_DATA | FLAG_GENERALDELTA REVLOGV1_FLAGS = FLAG_INLINE_DATA | FLAG_GENERALDELTA
REVLOGV2_FLAGS = FLAG_INLINE_DATA REVLOGV2_FLAGS = FLAG_INLINE_DATA
### individual entry
# revlog index flags # revlog index flags
# For historical reasons, revlog's internal flags were exposed via the # For historical reasons, revlog's internal flags were exposed via the
# wire protocol and are even exposed in parts of the storage APIs. # wire protocol and are even exposed in parts of the storage APIs.
# revision has censor metadata, must be verified # revision has censor metadata, must be verified
REVIDX_ISCENSORED = repository.REVISION_FLAG_CENSORED REVIDX_ISCENSORED = repository.REVISION_FLAG_CENSORED
# revision hash does not match data (narrowhg) # revision hash does not match data (narrowhg)