Mercurial > hg
comparison mercurial/helptext/internals/requirements.txt @ 43632:2e017696181f
help: create packages for the help text
These files need to be loaded as resources with PyOxidizer, instead of using
filesystem representations. AFAICT, the resource loading mechanisms only work
for the named package given to it, and can't reach into a subdirectory.
While here, the `help` directory is renamed to `helptext`. Without this, trying
to load external help text crashed in mercurial/help.py when importing `.i18n`,
saying there's no `mercurial.help.i18n` module.
Differential Revision: https://phab.mercurial-scm.org/D7376
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Wed, 13 Nov 2019 21:52:25 -0500 |
parents | mercurial/help/internals/requirements.txt@1bc7d4cb4182 |
children | 526d69eeea31 |
comparison
equal
deleted
inserted
replaced
43631:d3c4368099ed | 43632:2e017696181f |
---|---|
1 Repositories contain a file (``.hg/requires``) containing a list of | |
2 features/capabilities that are *required* for clients to interface | |
3 with the repository. This file has been present in Mercurial since | |
4 version 0.9.2 (released December 2006). | |
5 | |
6 One of the first things clients do when opening a repository is read | |
7 ``.hg/requires`` and verify that all listed requirements are supported, | |
8 aborting if not. Requirements are therefore a strong mechanism to | |
9 prevent incompatible clients from reading from unknown repository | |
10 formats or even corrupting them by writing to them. | |
11 | |
12 Extensions may add requirements. When they do this, clients not running | |
13 an extension will be unable to read from repositories. | |
14 | |
15 The following sections describe the requirements defined by the | |
16 Mercurial core distribution. | |
17 | |
18 revlogv1 | |
19 ======== | |
20 | |
21 When present, revlogs are version 1 (RevlogNG). RevlogNG was introduced | |
22 in 2006. The ``revlogv1`` requirement has been enabled by default | |
23 since the ``requires`` file was introduced in Mercurial 0.9.2. | |
24 | |
25 If this requirement is not present, version 0 revlogs are assumed. | |
26 | |
27 store | |
28 ===== | |
29 | |
30 The *store* repository layout should be used. | |
31 | |
32 This requirement has been enabled by default since the ``requires`` file | |
33 was introduced in Mercurial 0.9.2. | |
34 | |
35 fncache | |
36 ======= | |
37 | |
38 The *fncache* repository layout should be used. | |
39 | |
40 The *fncache* layout hash encodes filenames with long paths and | |
41 encodes reserved filenames. | |
42 | |
43 This requirement is enabled by default when the *store* requirement is | |
44 enabled (which is the default behavior). It was introduced in Mercurial | |
45 1.1 (released December 2008). | |
46 | |
47 shared | |
48 ====== | |
49 | |
50 Denotes that the store for a repository is shared from another location | |
51 (defined by the ``.hg/sharedpath`` file). | |
52 | |
53 This requirement is set when a repository is created via :hg:`share`. | |
54 | |
55 The requirement was added in Mercurial 1.3 (released July 2009). | |
56 | |
57 relshared | |
58 ========= | |
59 | |
60 Derivative of ``shared``; the location of the store is relative to the | |
61 store of this repository. | |
62 | |
63 This requirement is set when a repository is created via :hg:`share` | |
64 using the ``--relative`` option. | |
65 | |
66 The requirement was added in Mercurial 4.2 (released May 2017). | |
67 | |
68 dotencode | |
69 ========= | |
70 | |
71 The *dotencode* repository layout should be used. | |
72 | |
73 The *dotencode* layout encodes the first period or space in filenames | |
74 to prevent issues on OS X and Windows. | |
75 | |
76 This requirement is enabled by default when the *store* requirement | |
77 is enabled (which is the default behavior). It was introduced in | |
78 Mercurial 1.7 (released November 2010). | |
79 | |
80 parentdelta | |
81 =========== | |
82 | |
83 Denotes a revlog delta encoding format that was experimental and | |
84 replaced by *generaldelta*. It should not be seen in the wild because | |
85 it was never enabled by default. | |
86 | |
87 This requirement was added in Mercurial 1.7 and removed in Mercurial | |
88 1.9. | |
89 | |
90 generaldelta | |
91 ============ | |
92 | |
93 Revlogs should be created with the *generaldelta* flag enabled. The | |
94 generaldelta flag will cause deltas to be encoded against a parent | |
95 revision instead of the previous revision in the revlog. | |
96 | |
97 Support for this requirement was added in Mercurial 1.9 (released | |
98 July 2011). The requirement was disabled on new repositories by | |
99 default until Mercurial 3.7 (released February 2016). | |
100 | |
101 manifestv2 | |
102 ========== | |
103 | |
104 Denotes that version 2 of manifests are being used. | |
105 | |
106 Support for this requirement was added in Mercurial 3.4 (released | |
107 May 2015). The new format failed to meet expectations and support | |
108 for the format and requirement were removed in Mercurial 4.6 | |
109 (released May 2018) since the feature never graduated frome experiment | |
110 status. | |
111 | |
112 treemanifest | |
113 ============ | |
114 | |
115 Denotes that tree manifests are being used. Tree manifests are | |
116 one manifest per directory (as opposed to a single flat manifest). | |
117 | |
118 Support for this requirement was added in Mercurial 3.4 (released | |
119 August 2015). The requirement is currently experimental and is | |
120 disabled by default. | |
121 | |
122 exp-sparse | |
123 ========== | |
124 | |
125 The working directory is sparse (only contains a subset of files). | |
126 | |
127 Support for this requirement was added in Mercurial 4.3 (released | |
128 August 2017). This requirement and feature are experimental and may | |
129 disappear in a future Mercurial release. The requirement will only | |
130 be present on repositories that have opted in to a sparse working | |
131 directory. | |
132 | |
133 bookmarksinstore | |
134 ================== | |
135 | |
136 Bookmarks are stored in ``.hg/store/`` instead of directly in ``.hg/`` | |
137 where they used to be stored. The active bookmark is still stored | |
138 directly in ``.hg/``. This makes them always shared by ``hg share``, | |
139 whether or not ``-B`` was passed. | |
140 | |
141 Support for this requirement was added in Mercurial 5.1 (released | |
142 August 2019). The requirement will only be present on repositories | |
143 that have opted in to this format (by having | |
144 ``format.bookmarks-in-store=true`` set when they were created). |