##// END OF EJS Templates
upstream » mercurial-mirror
RSS

Clone from https://www.mercurial-scm.org/repo/hg-all

helptext: document exp-sharesafe in internals/requirements.txt...
Pulkit Goyal -
r46056:63eb1b5c default
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -1,157 +1,176 b''
1 1 Repositories contain a file (``.hg/requires``) containing a list of
2 2 features/capabilities that are *required* for clients to interface
3 3 with the repository. This file has been present in Mercurial since
4 4 version 0.9.2 (released December 2006).
5 5
6 6 One of the first things clients do when opening a repository is read
7 7 ``.hg/requires`` and verify that all listed requirements are supported,
8 8 aborting if not. Requirements are therefore a strong mechanism to
9 9 prevent incompatible clients from reading from unknown repository
10 10 formats or even corrupting them by writing to them.
11 11
12 12 Extensions may add requirements. When they do this, clients not running
13 13 an extension will be unable to read from repositories.
14 14
15 15 The following sections describe the requirements defined by the
16 16 Mercurial core distribution.
17 17
18 18 revlogv1
19 19 ========
20 20
21 21 When present, revlogs are version 1 (RevlogNG). RevlogNG was introduced
22 22 in 2006. The ``revlogv1`` requirement has been enabled by default
23 23 since the ``requires`` file was introduced in Mercurial 0.9.2.
24 24
25 25 If this requirement is not present, version 0 revlogs are assumed.
26 26
27 27 store
28 28 =====
29 29
30 30 The *store* repository layout should be used.
31 31
32 32 This requirement has been enabled by default since the ``requires`` file
33 33 was introduced in Mercurial 0.9.2.
34 34
35 35 fncache
36 36 =======
37 37
38 38 The *fncache* repository layout should be used.
39 39
40 40 The *fncache* layout hash encodes filenames with long paths and
41 41 encodes reserved filenames.
42 42
43 43 This requirement is enabled by default when the *store* requirement is
44 44 enabled (which is the default behavior). It was introduced in Mercurial
45 45 1.1 (released December 2008).
46 46
47 47 shared
48 48 ======
49 49
50 50 Denotes that the store for a repository is shared from another location
51 51 (defined by the ``.hg/sharedpath`` file).
52 52
53 53 This requirement is set when a repository is created via :hg:`share`.
54 54
55 55 The requirement was added in Mercurial 1.3 (released July 2009).
56 56
57 57 relshared
58 58 =========
59 59
60 60 Derivative of ``shared``; the location of the store is relative to the
61 61 store of this repository.
62 62
63 63 This requirement is set when a repository is created via :hg:`share`
64 64 using the ``--relative`` option.
65 65
66 66 The requirement was added in Mercurial 4.2 (released May 2017).
67 67
68 68 dotencode
69 69 =========
70 70
71 71 The *dotencode* repository layout should be used.
72 72
73 73 The *dotencode* layout encodes the first period or space in filenames
74 74 to prevent issues on OS X and Windows.
75 75
76 76 This requirement is enabled by default when the *store* requirement
77 77 is enabled (which is the default behavior). It was introduced in
78 78 Mercurial 1.7 (released November 2010).
79 79
80 80 parentdelta
81 81 ===========
82 82
83 83 Denotes a revlog delta encoding format that was experimental and
84 84 replaced by *generaldelta*. It should not be seen in the wild because
85 85 it was never enabled by default.
86 86
87 87 This requirement was added in Mercurial 1.7 and removed in Mercurial
88 88 1.9.
89 89
90 90 generaldelta
91 91 ============
92 92
93 93 Revlogs should be created with the *generaldelta* flag enabled. The
94 94 generaldelta flag will cause deltas to be encoded against a parent
95 95 revision instead of the previous revision in the revlog.
96 96
97 97 Support for this requirement was added in Mercurial 1.9 (released
98 98 July 2011). The requirement was disabled on new repositories by
99 99 default until Mercurial 3.7 (released February 2016).
100 100
101 101 manifestv2
102 102 ==========
103 103
104 104 Denotes that version 2 of manifests are being used.
105 105
106 106 Support for this requirement was added in Mercurial 3.4 (released
107 107 May 2015). The new format failed to meet expectations and support
108 108 for the format and requirement were removed in Mercurial 4.6
109 109 (released May 2018) since the feature never graduated frome experiment
110 110 status.
111 111
112 112 treemanifest
113 113 ============
114 114
115 115 Denotes that tree manifests are being used. Tree manifests are
116 116 one manifest per directory (as opposed to a single flat manifest).
117 117
118 118 Support for this requirement was added in Mercurial 3.4 (released
119 119 August 2015). The requirement is currently experimental and is
120 120 disabled by default.
121 121
122 122 exp-sparse
123 123 ==========
124 124
125 125 The working directory is sparse (only contains a subset of files).
126 126
127 127 Support for this requirement was added in Mercurial 4.3 (released
128 128 August 2017). This requirement and feature are experimental and may
129 129 disappear in a future Mercurial release. The requirement will only
130 130 be present on repositories that have opted in to a sparse working
131 131 directory.
132 132
133 133 bookmarksinstore
134 134 ==================
135 135
136 136 Bookmarks are stored in ``.hg/store/`` instead of directly in ``.hg/``
137 137 where they used to be stored. The active bookmark is still stored
138 138 directly in ``.hg/``. This makes them always shared by ``hg share``,
139 139 whether or not ``-B`` was passed.
140 140
141 141 Support for this requirement was added in Mercurial 5.1 (released
142 142 August 2019). The requirement will only be present on repositories
143 143 that have opted in to this format (by having
144 144 ``format.bookmarks-in-store=true`` set when they were created).
145 145
146 146 persistent-nodemap
147 147 ==================
148 148
149 149 The `nodemap` index (mapping nodeid to local revision number) is persisted on
150 150 disk. This provides speed benefit (if the associated native code is used). The
151 151 persistent nodemap is only used for two revlogs: the changelog and the
152 152 manifestlog.
153 153
154 154 Support for this requirement was added in Mercurial 5.5 (released August 2020).
155 155 Note that as of 5.5, only installations compiled with the Rust extension will
156 156 benefit from a speedup. The other installations will do the necessary work to
157 157 keep the index up to date, but will suffer a slowdown.
158
159 exp-sharesafe
160 =============
161
162 NOTE: This requirement is for internal development only. The semantics are not
163 frozed yet, the feature is experimental. It's not advised to use it for any
164 production repository yet.
165
166 Represents that the repository can be shared safely. Requirements and config of
167 the source repository will be shared.
168 Requirements are stored in ``.hg/store`` instead of directly in ``.hg/`` where
169 they used to be stored. Some working copy related requirements are still stored
170 in ``.hg/``.
171 Shares read the ``.hg/hgrc`` of the source repository.
172
173 Support for this requirement was added in Mercurial 5.6 (released
174 November 2020). The requirement will only be present on repositories that have
175 opted in to this format (by having ``format.exp-share-safe=true`` set when
176 they were created).
General Comments 0
You need to be logged in to leave comments. Login now