mercurial/helptext/internals/requirements.txt
author Matt Harbison <matt_harbison@yahoo.com>
Tue, 13 Dec 2022 16:48:47 -0500
changeset 49800 c43b283a19c3
parent 46350 e30ef4a36e1d
permissions -rw-r--r--
windows: drop an unused method The only caller was removed in 563eb25e079b.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     1
Repositories contain a file (``.hg/requires``) containing a list of
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     2
features/capabilities that are *required* for clients to interface
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     3
with the repository. This file has been present in Mercurial since
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     4
version 0.9.2 (released December 2006).
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     5
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     6
One of the first things clients do when opening a repository is read
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     7
``.hg/requires`` and verify that all listed requirements are supported,
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     8
aborting if not. Requirements are therefore a strong mechanism to
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
     9
prevent incompatible clients from reading from unknown repository
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    10
formats or even corrupting them by writing to them.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    11
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    12
Extensions may add requirements. When they do this, clients not running
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    13
an extension will be unable to read from repositories.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    14
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    15
The following sections describe the requirements defined by the
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    16
Mercurial core distribution.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    17
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    18
revlogv1
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    19
========
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    20
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    21
When present, revlogs are version 1 (RevlogNG). RevlogNG was introduced
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    22
in 2006. The ``revlogv1`` requirement has been enabled by default
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    23
since the ``requires`` file was introduced in Mercurial 0.9.2.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    24
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    25
If this requirement is not present, version 0 revlogs are assumed.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    26
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    27
store
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    28
=====
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    29
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    30
The *store* repository layout should be used.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    31
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    32
This requirement has been enabled by default since the ``requires`` file
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    33
was introduced in Mercurial 0.9.2.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    34
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    35
fncache
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    36
=======
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    37
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    38
The *fncache* repository layout should be used.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    39
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    40
The *fncache* layout hash encodes filenames with long paths and
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    41
encodes reserved filenames.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    42
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    43
This requirement is enabled by default when the *store* requirement is
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    44
enabled (which is the default behavior). It was introduced in Mercurial
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    45
1.1 (released December 2008).
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    46
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    47
shared
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    48
======
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    49
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    50
Denotes that the store for a repository is shared from another location
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    51
(defined by the ``.hg/sharedpath`` file).
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    52
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    53
This requirement is set when a repository is created via :hg:`share`.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    54
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    55
The requirement was added in Mercurial 1.3 (released July 2009).
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    56
31133
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    57
relshared
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    58
=========
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    59
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    60
Derivative of ``shared``; the location of the store is relative to the
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    61
store of this repository.
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    62
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    63
This requirement is set when a repository is created via :hg:`share`
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    64
using the ``--relative`` option.
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    65
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    66
The requirement was added in Mercurial 4.2 (released May 2017).
23080c03a604 share: add --relative flag to store a relative path to the source
Dan Villiom Podlaski Christiansen <danchr@gmail.com>
parents: 29747
diff changeset
    67
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    68
dotencode
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    69
=========
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    70
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    71
The *dotencode* repository layout should be used.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    72
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    73
The *dotencode* layout encodes the first period or space in filenames
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    74
to prevent issues on OS X and Windows.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    75
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    76
This requirement is enabled by default when the *store* requirement
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    77
is enabled (which is the default behavior). It was introduced in
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    78
Mercurial 1.7 (released November 2010).
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    79
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    80
parentdelta
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    81
===========
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    82
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    83
Denotes a revlog delta encoding format that was experimental and
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    84
replaced by *generaldelta*. It should not be seen in the wild because
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    85
it was never enabled by default.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    86
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    87
This requirement was added in Mercurial 1.7 and removed in Mercurial
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    88
1.9.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    89
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    90
generaldelta
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    91
============
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    92
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    93
Revlogs should be created with the *generaldelta* flag enabled. The
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    94
generaldelta flag will cause deltas to be encoded against a parent
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    95
revision instead of the previous revision in the revlog.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    96
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    97
Support for this requirement was added in Mercurial 1.9 (released
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    98
July 2011). The requirement was disabled on new repositories by
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
    99
default until Mercurial 3.7 (released February 2016).
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   100
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   101
manifestv2
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
   102
==========
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   103
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   104
Denotes that version 2 of manifests are being used.
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   105
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   106
Support for this requirement was added in Mercurial 3.4 (released
36373
0147a4730420 cleanup: say goodbye to manifestv2 format
Augie Fackler <augie@google.com>
parents: 33556
diff changeset
   107
May 2015). The new format failed to meet expectations and support
0147a4730420 cleanup: say goodbye to manifestv2 format
Augie Fackler <augie@google.com>
parents: 33556
diff changeset
   108
for the format and requirement were removed in Mercurial 4.6
0147a4730420 cleanup: say goodbye to manifestv2 format
Augie Fackler <augie@google.com>
parents: 33556
diff changeset
   109
(released May 2018) since the feature never graduated frome experiment
0147a4730420 cleanup: say goodbye to manifestv2 format
Augie Fackler <augie@google.com>
parents: 33556
diff changeset
   110
status.
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   111
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   112
treemanifest
29747
aba2bb2a6d0f help: don't try to render a section on sub-topics
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
   113
============
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   114
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   115
Denotes that tree manifests are being used. Tree manifests are
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   116
one manifest per directory (as opposed to a single flat manifest).
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   117
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   118
Support for this requirement was added in Mercurial 3.4 (released
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   119
August 2015). The requirement is currently experimental and is
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents:
diff changeset
   120
disabled by default.
33556
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   121
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   122
exp-sparse
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   123
==========
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   124
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   125
The working directory is sparse (only contains a subset of files).
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   126
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   127
Support for this requirement was added in Mercurial 4.3 (released
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   128
August 2017). This requirement and feature are experimental and may
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   129
disappear in a future Mercurial release. The requirement will only
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   130
be present on repositories that have opted in to a sparse working
22371eabb3b1 sparse: add a requirement when a repository uses sparse (BC)
Gregory Szorc <gregory.szorc@gmail.com>
parents: 31133
diff changeset
   131
directory.
42352
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   132
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   133
bookmarksinstore
46350
e30ef4a36e1d doc: fix a formatting error in requirements.txt
Matt Harbison <matt_harbison@yahoo.com>
parents: 46349
diff changeset
   134
================
42352
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   135
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   136
Bookmarks are stored in ``.hg/store/`` instead of directly in ``.hg/``
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   137
where they used to be stored. The active bookmark is still stored
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   138
directly in ``.hg/``. This makes them always shared by ``hg share``,
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   139
whether or not ``-B`` was passed.
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   140
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   141
Support for this requirement was added in Mercurial 5.1 (released
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   142
August 2019). The requirement will only be present on repositories
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   143
that have opted in to this format (by having
1bc7d4cb4182 help: document new "bookmarksinstore" requirement in internals.requirements
Martin von Zweigbergk <martinvonz@google.com>
parents: 36373
diff changeset
   144
``format.bookmarks-in-store=true`` set when they were created).
44841
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   145
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   146
persistent-nodemap
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   147
==================
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   148
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   149
The `nodemap` index (mapping nodeid to local revision number) is persisted on
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   150
disk. This provides speed benefit (if the associated native code is used). The
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   151
persistent nodemap is only used for two revlogs: the changelog and the
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   152
manifestlog.
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   153
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   154
Support for this requirement was added in Mercurial 5.5 (released August 2020).
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   155
Note that as of 5.5, only installations compiled with the Rust extension will
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   156
benefit from a speedup. The other installations will do the necessary work to
526d69eeea31 upgrade: support upgrade and downgrade from persistent nodemap
Pierre-Yves David <pierre-yves.david@octobus.net>
parents: 43632
diff changeset
   157
keep the index up to date, but will suffer a slowdown.
45484
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   158
46349
86842c4accc1 doc: drop the `exp-` prefix from the `share-safe` requirement
Matt Harbison <matt_harbison@yahoo.com>
parents: 46337
diff changeset
   159
share-safe
86842c4accc1 doc: drop the `exp-` prefix from the `share-safe` requirement
Matt Harbison <matt_harbison@yahoo.com>
parents: 46337
diff changeset
   160
==========
45484
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   161
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   162
Represents that the repository can be shared safely. Requirements and config of
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   163
the source repository will be shared.
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   164
Requirements are stored in ``.hg/store`` instead of directly in ``.hg/`` where
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   165
they used to be stored. Some working copy related requirements are still stored
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   166
in ``.hg/``.
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   167
Shares read the ``.hg/hgrc`` of the source repository.
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   168
46005
2c0ddb79a8cd helptext: update first hg version when share-safe will be released
Pulkit Goyal <7895pulkit@gmail.com>
parents: 45484
diff changeset
   169
Support for this requirement was added in Mercurial 5.7 (released
2c0ddb79a8cd helptext: update first hg version when share-safe will be released
Pulkit Goyal <7895pulkit@gmail.com>
parents: 45484
diff changeset
   170
February 2021). The requirement will only be present on repositories that have
46337
6e81446bf1d9 share: move share safe functionality out of experimental
Pulkit Goyal <7895pulkit@gmail.com>
parents: 46005
diff changeset
   171
opted in to this format (by having ``format.use-share-safe=true`` set when
45484
63eb1b5c580d helptext: document exp-sharesafe in internals/requirements.txt
Pulkit Goyal <7895pulkit@gmail.com>
parents: 44841
diff changeset
   172
they were created).