Mercurial > hg
annotate mercurial/help/glossary.txt @ 24946:c44534209a0a
bookmarks: rename readcurrent to readactive (API)
Today, the terms 'active' and 'current' are interchangeably used throughout the
codebase in reference to the active bookmark (the bookmark that will be updated
with the next commit). This leads to confusion among developers and users.
This patch is part of a series to standardize the usage to 'active' throughout
the mercurial codebase and user interface.
author | Ryan McElroy <rmcelroy@fb.com> |
---|---|
date | Mon, 13 Apr 2015 23:03:13 -0700 |
parents | 3971f64d7a25 |
children | 220ee13946d3 |
rev | line source |
---|---|
11356 | 1 Ancestor |
2 Any changeset that can be reached by an unbroken chain of parent | |
3 changesets from a given changeset. More precisely, the ancestors | |
4 of a changeset can be defined by two properties: a parent of a | |
5 changeset is an ancestor, and a parent of an ancestor is an | |
6 ancestor. See also: 'Descendant'. | |
7 | |
14630
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
8 Bookmark |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
9 Bookmarks are pointers to certain commits that move when |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
10 committing. They are similar to tags in that it is possible to use |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
11 bookmark names in all places where Mercurial expects a changeset |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
12 ID, e.g., with :hg:`update`. Unlike tags, bookmarks move along |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
13 when you make a commit. |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
14 |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
15 Bookmarks can be renamed, copied and deleted. Bookmarks are local, |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
16 unless they are explicitly pushed or pulled between repositories. |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
17 Pushing and pulling bookmarks allow you to collaborate with others |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
18 on a branch without creating a named branch. |
f536151d392f
glossary: add entry for "Bookmark"
Martin Geisler <mg@aragost.com>
parents:
14629
diff
changeset
|
19 |
11356 | 20 Branch |
21 (Noun) A child changeset that has been created from a parent that | |
22 is not a head. These are known as topological branches, see | |
11437
9fa255c32406
help: glossary.txt formatting fixes
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
11436
diff
changeset
|
23 'Branch, topological'. If a topological branch is named, it becomes |
11356 | 24 a named branch. If a topological branch is not named, it becomes |
25 an anonymous branch. See 'Branch, anonymous' and 'Branch, named'. | |
26 | |
27 Branches may be created when changes are pulled from or pushed to | |
28 a remote repository, since new heads may be created by these | |
29 operations. Note that the term branch can also be used informally | |
30 to describe a development process in which certain development is | |
11685 | 31 done independently of other development. This is sometimes done |
11356 | 32 explicitly with a named branch, but it can also be done locally, |
33 using bookmarks or clones and anonymous branches. | |
34 | |
35 Example: "The experimental branch". | |
36 | |
37 (Verb) The action of creating a child changeset which results in | |
38 its parent having more than one child. | |
39 | |
40 Example: "I'm going to branch at X". | |
41 | |
42 Branch, anonymous | |
43 Every time a new child changeset is created from a parent that is not | |
44 a head and the name of the branch is not changed, a new anonymous | |
45 branch is created. | |
46 | |
47 Branch, closed | |
48 A named branch whose branch heads have all been closed. | |
49 | |
50 Branch, default | |
51 The branch assigned to a changeset when no name has previously been | |
52 assigned. | |
53 | |
54 Branch head | |
55 See 'Head, branch'. | |
56 | |
11911
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
57 Branch, inactive |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
58 If a named branch has no topological heads, it is considered to be |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
59 inactive. As an example, a feature branch becomes inactive when it |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
60 is merged into the default branch. The :hg:`branches` command |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
61 shows inactive branches by default, though they can be hidden with |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
62 :hg:`branches --active`. |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
63 |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
64 NOTE: this concept is deprecated because it is too implicit. |
11927 | 65 Branches should now be explicitly closed using :hg:`commit |
11911
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
66 --close-branch` when they are no longer needed. |
528ff7610cba
glossary: add entry for "Branch, inactive"
Martin Geisler <mg@lazybytes.net>
parents:
11511
diff
changeset
|
67 |
11356 | 68 Branch, named |
69 A collection of changesets which have the same branch name. By | |
70 default, children of a changeset in a named branch belong to the | |
71 same named branch. A child can be explicitly assigned to a | |
72 different branch. See :hg:`help branch`, :hg:`help branches` and | |
73 :hg:`commit --close-branch` for more information on managing | |
74 branches. | |
75 | |
76 Named branches can be thought of as a kind of namespace, dividing | |
77 the collection of changesets that comprise the repository into a | |
78 collection of disjoint subsets. A named branch is not necessarily | |
79 a topological branch. If a new named branch is created from the | |
80 head of another named branch, or the default branch, but no | |
11436
45eadf71df22
help: fix glossary.txt named branches description
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
11356
diff
changeset
|
81 further changesets are added to that previous branch, then that |
45eadf71df22
help: fix glossary.txt named branches description
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
11356
diff
changeset
|
82 previous branch will be a branch in name only. |
11356 | 83 |
84 Branch tip | |
85 See 'Tip, branch'. | |
86 | |
87 Branch, topological | |
88 Every time a new child changeset is created from a parent that is | |
89 not a head, a new topological branch is created. If a topological | |
90 branch is named, it becomes a named branch. If a topological | |
91 branch is not named, it becomes an anonymous branch of the | |
92 current, possibly default, branch. | |
93 | |
94 Changelog | |
95 A record of the changesets in the order in which they were added | |
96 to the repository. This includes details such as changeset id, | |
97 author, commit message, date, and list of changed files. | |
98 | |
99 Changeset | |
100 A snapshot of the state of the repository used to record a change. | |
101 | |
102 Changeset, child | |
103 The converse of parent changeset: if P is a parent of C, then C is | |
104 a child of P. There is no limit to the number of children that a | |
105 changeset may have. | |
106 | |
107 Changeset id | |
108 A SHA-1 hash that uniquely identifies a changeset. It may be | |
11718
3e979f47a4c9
help: fix bytes/digit confusion for hashes
Matt Mackall <mpm@selenic.com>
parents:
11685
diff
changeset
|
109 represented as either a "long" 40 hexadecimal digit string, or a |
3e979f47a4c9
help: fix bytes/digit confusion for hashes
Matt Mackall <mpm@selenic.com>
parents:
11685
diff
changeset
|
110 "short" 12 hexadecimal digit string. |
11356 | 111 |
112 Changeset, merge | |
113 A changeset with two parents. This occurs when a merge is | |
114 committed. | |
115 | |
116 Changeset, parent | |
117 A revision upon which a child changeset is based. Specifically, a | |
118 parent changeset of a changeset C is a changeset whose node | |
119 immediately precedes C in the DAG. Changesets have at most two | |
120 parents. | |
121 | |
122 Checkout | |
123 (Noun) The working directory being updated to a specific | |
124 revision. This use should probably be avoided where possible, as | |
125 changeset is much more appropriate than checkout in this context. | |
126 | |
127 Example: "I'm using checkout X." | |
128 | |
129 (Verb) Updating the working directory to a specific changeset. See | |
130 :hg:`help update`. | |
131 | |
132 Example: "I'm going to check out changeset X." | |
133 | |
134 Child changeset | |
135 See 'Changeset, child'. | |
136 | |
137 Close changeset | |
16501
340d047ea577
doc: fix careless document miss for term 'Close changeset' in glossary
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
16039
diff
changeset
|
138 See 'Head, closed branch' |
11356 | 139 |
140 Closed branch | |
141 See 'Branch, closed'. | |
142 | |
143 Clone | |
144 (Noun) An entire or partial copy of a repository. The partial | |
145 clone must be in the form of a revision and its ancestors. | |
146 | |
147 Example: "Is your clone up to date?". | |
148 | |
149 (Verb) The process of creating a clone, using :hg:`clone`. | |
150 | |
151 Example: "I'm going to clone the repository". | |
152 | |
153 Closed branch head | |
154 See 'Head, closed branch'. | |
155 | |
156 Commit | |
157 (Noun) A synonym for changeset. | |
158 | |
159 Example: "Is the bug fixed in your recent commit?" | |
160 | |
161 (Verb) The act of recording changes to a repository. When files | |
162 are committed in a working directory, Mercurial finds the | |
163 differences between the committed files and their parent | |
164 changeset, creating a new changeset in the repository. | |
165 | |
166 Example: "You should commit those changes now." | |
167 | |
168 Cset | |
169 A common abbreviation of the term changeset. | |
170 | |
171 DAG | |
172 The repository of changesets of a distributed version control | |
173 system (DVCS) can be described as a directed acyclic graph (DAG), | |
174 consisting of nodes and edges, where nodes correspond to | |
175 changesets and edges imply a parent -> child relation. This graph | |
20147
7547bcc1a3ad
glossary: don't mention obsolete graphlog extension
Martin Geisler <martin@geisler.net>
parents:
16502
diff
changeset
|
176 can be visualized by graphical tools such as :hg:`log --graph`. In |
7547bcc1a3ad
glossary: don't mention obsolete graphlog extension
Martin Geisler <martin@geisler.net>
parents:
16502
diff
changeset
|
177 Mercurial, the DAG is limited by the requirement for children to |
7547bcc1a3ad
glossary: don't mention obsolete graphlog extension
Martin Geisler <martin@geisler.net>
parents:
16502
diff
changeset
|
178 have at most two parents. |
11356 | 179 |
23027
3971f64d7a25
glossary: add deprecated and experimental
Matt Mackall <mpm@selenic.com>
parents:
20147
diff
changeset
|
180 Deprecated |
3971f64d7a25
glossary: add deprecated and experimental
Matt Mackall <mpm@selenic.com>
parents:
20147
diff
changeset
|
181 Feature removed from documentation, but not scheduled for removal. |
3971f64d7a25
glossary: add deprecated and experimental
Matt Mackall <mpm@selenic.com>
parents:
20147
diff
changeset
|
182 |
11356 | 183 Default branch |
184 See 'Branch, default'. | |
185 | |
186 Descendant | |
187 Any changeset that can be reached by a chain of child changesets | |
188 from a given changeset. More precisely, the descendants of a | |
189 changeset can be defined by two properties: the child of a | |
190 changeset is a descendant, and the child of a descendant is a | |
191 descendant. See also: 'Ancestor'. | |
192 | |
193 Diff | |
194 (Noun) The difference between the contents and attributes of files | |
195 in two changesets or a changeset and the current working | |
196 directory. The difference is usually represented in a standard | |
197 form called a "diff" or "patch". The "git diff" format is used | |
198 when the changes include copies, renames, or changes to file | |
199 attributes, none of which can be represented/handled by classic | |
200 "diff" and "patch". | |
201 | |
202 Example: "Did you see my correction in the diff?" | |
203 | |
204 (Verb) Diffing two changesets is the action of creating a diff or | |
205 patch. | |
206 | |
207 Example: "If you diff with changeset X, you will see what I mean." | |
208 | |
209 Directory, working | |
210 The working directory represents the state of the files tracked by | |
211 Mercurial, that will be recorded in the next commit. The working | |
212 directory initially corresponds to the snapshot at an existing | |
213 changeset, known as the parent of the working directory. See | |
11511
9d905b9769af
glossary: fixed typo in "Directory, working" description
Renato Cunha <renatoc@gmail.com>
parents:
11437
diff
changeset
|
214 'Parent, working directory'. The state may be modified by changes |
11356 | 215 to the files introduced manually or by a merge. The repository |
216 metadata exists in the .hg directory inside the working directory. | |
217 | |
16037 | 218 Draft |
219 Changesets in the draft phase have not been shared with publishing | |
220 repositories and may thus be safely changed by history-modifying | |
221 extensions. See :hg:`help phases`. | |
222 | |
23027
3971f64d7a25
glossary: add deprecated and experimental
Matt Mackall <mpm@selenic.com>
parents:
20147
diff
changeset
|
223 Experimental |
3971f64d7a25
glossary: add deprecated and experimental
Matt Mackall <mpm@selenic.com>
parents:
20147
diff
changeset
|
224 Feature that may change or be removed at a later date. |
3971f64d7a25
glossary: add deprecated and experimental
Matt Mackall <mpm@selenic.com>
parents:
20147
diff
changeset
|
225 |
11356 | 226 Graph |
20147
7547bcc1a3ad
glossary: don't mention obsolete graphlog extension
Martin Geisler <martin@geisler.net>
parents:
16502
diff
changeset
|
227 See DAG and :hg:`log --graph`. |
11356 | 228 |
229 Head | |
230 The term 'head' may be used to refer to both a branch head or a | |
231 repository head, depending on the context. See 'Head, branch' and | |
232 'Head, repository' for specific definitions. | |
233 | |
234 Heads are where development generally takes place and are the | |
235 usual targets for update and merge operations. | |
236 | |
237 Head, branch | |
238 A changeset with no descendants on the same named branch. | |
239 | |
240 Head, closed branch | |
241 A changeset that marks a head as no longer interesting. The closed | |
242 head is no longer listed by :hg:`heads`. A branch is considered | |
243 closed when all its heads are closed and consequently is not | |
244 listed by :hg:`branches`. | |
245 | |
16502
8298d220cbf9
doc: add description about re-opening closed heads to 'Head, closed branch' in glossary
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
16501
diff
changeset
|
246 Closed heads can be re-opened by committing new changeset as the |
8298d220cbf9
doc: add description about re-opening closed heads to 'Head, closed branch' in glossary
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
16501
diff
changeset
|
247 child of the changeset that marks a head as closed. |
8298d220cbf9
doc: add description about re-opening closed heads to 'Head, closed branch' in glossary
FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
parents:
16501
diff
changeset
|
248 |
11356 | 249 Head, repository |
250 A topological head which has not been closed. | |
251 | |
252 Head, topological | |
253 A changeset with no children in the repository. | |
254 | |
255 History, immutable | |
256 Once committed, changesets cannot be altered. Extensions which | |
257 appear to change history actually create new changesets that | |
258 replace existing ones, and then destroy the old changesets. Doing | |
259 so in public repositories can result in old changesets being | |
260 reintroduced to the repository. | |
261 | |
262 History, rewriting | |
263 The changesets in a repository are immutable. However, extensions | |
264 to Mercurial can be used to alter the repository, usually in such | |
265 a way as to preserve changeset contents. | |
266 | |
267 Immutable history | |
268 See 'History, immutable'. | |
269 | |
270 Merge changeset | |
271 See 'Changeset, merge'. | |
272 | |
273 Manifest | |
274 Each changeset has a manifest, which is the list of files that are | |
275 tracked by the changeset. | |
276 | |
277 Merge | |
278 Used to bring together divergent branches of work. When you update | |
279 to a changeset and then merge another changeset, you bring the | |
280 history of the latter changeset into your working directory. Once | |
281 conflicts are resolved (and marked), this merge may be committed | |
282 as a merge changeset, bringing two branches together in the DAG. | |
283 | |
284 Named branch | |
285 See 'Branch, named'. | |
286 | |
287 Null changeset | |
288 The empty changeset. It is the parent state of newly-initialized | |
289 repositories and repositories with no checked out revision. It is | |
290 thus the parent of root changesets and the effective ancestor when | |
291 merging unrelated changesets. Can be specified by the alias 'null' | |
292 or by the changeset ID '000000000000'. | |
293 | |
294 Parent | |
295 See 'Changeset, parent'. | |
296 | |
297 Parent changeset | |
298 See 'Changeset, parent'. | |
299 | |
300 Parent, working directory | |
301 The working directory parent reflects a virtual revision which is | |
302 the child of the changeset (or two changesets with an uncommitted | |
303 merge) shown by :hg:`parents`. This is changed with | |
304 :hg:`update`. Other commands to see the working directory parent | |
305 are :hg:`summary` and :hg:`id`. Can be specified by the alias ".". | |
306 | |
307 Patch | |
308 (Noun) The product of a diff operation. | |
309 | |
310 Example: "I've sent you my patch." | |
311 | |
312 (Verb) The process of using a patch file to transform one | |
313 changeset into another. | |
314 | |
315 Example: "You will need to patch that revision." | |
316 | |
16037 | 317 Phase |
318 A per-changeset state tracking how the changeset has been or | |
319 should be shared. See :hg:`help phases`. | |
320 | |
321 Public | |
322 Changesets in the public phase have been shared with publishing | |
323 repositories and are therefore considered immutable. See :hg:`help | |
324 phases`. | |
325 | |
11356 | 326 Pull |
327 An operation in which changesets in a remote repository which are | |
328 not in the local repository are brought into the local | |
329 repository. Note that this operation without special arguments | |
330 only updates the repository, it does not update the files in the | |
331 working directory. See :hg:`help pull`. | |
332 | |
333 Push | |
334 An operation in which changesets in a local repository which are | |
335 not in a remote repository are sent to the remote repository. Note | |
336 that this operation only adds changesets which have been committed | |
337 locally to the remote repository. Uncommitted changes are not | |
338 sent. See :hg:`help push`. | |
339 | |
340 Repository | |
341 The metadata describing all recorded states of a collection of | |
342 files. Each recorded state is represented by a changeset. A | |
343 repository is usually (but not always) found in the ``.hg`` | |
344 subdirectory of a working directory. Any recorded state can be | |
345 recreated by "updating" a working directory to a specific | |
346 changeset. | |
347 | |
348 Repository head | |
349 See 'Head, repository'. | |
350 | |
351 Revision | |
352 A state of the repository at some point in time. Earlier revisions | |
353 can be updated to by using :hg:`update`. See also 'Revision | |
354 number'; See also 'Changeset'. | |
355 | |
356 Revision number | |
357 This integer uniquely identifies a changeset in a specific | |
358 repository. It represents the order in which changesets were added | |
359 to a repository, starting with revision number 0. Note that the | |
360 revision number may be different in each clone of a repository. To | |
361 identify changesets uniquely between different clones, see | |
362 'Changeset id'. | |
363 | |
364 Revlog | |
365 History storage mechanism used by Mercurial. It is a form of delta | |
366 encoding, with occasional full revision of data followed by delta | |
367 of each successive revision. It includes data and an index | |
368 pointing to the data. | |
369 | |
370 Rewriting history | |
11437
9fa255c32406
help: glossary.txt formatting fixes
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
11436
diff
changeset
|
371 See 'History, rewriting'. |
11356 | 372 |
373 Root | |
374 A changeset that has only the null changeset as its parent. Most | |
375 repositories have only a single root changeset. | |
376 | |
16037 | 377 Secret |
16039
093b75c7b44b
pull: return 1 when no changes found (BC)
Matt Mackall <mpm@selenic.com>
parents:
16037
diff
changeset
|
378 Changesets in the secret phase may not be shared via push, pull, |
093b75c7b44b
pull: return 1 when no changes found (BC)
Matt Mackall <mpm@selenic.com>
parents:
16037
diff
changeset
|
379 or clone. See :hg:`help phases`. |
16037 | 380 |
14629
c3f2152e423d
glossary: add entry for "Tag"
Martin Geisler <mg@aragost.com>
parents:
11937
diff
changeset
|
381 Tag |
c3f2152e423d
glossary: add entry for "Tag"
Martin Geisler <mg@aragost.com>
parents:
11937
diff
changeset
|
382 An alternative name given to a changeset. Tags can be used in all |
c3f2152e423d
glossary: add entry for "Tag"
Martin Geisler <mg@aragost.com>
parents:
11937
diff
changeset
|
383 places where Mercurial expects a changeset ID, e.g., with |
c3f2152e423d
glossary: add entry for "Tag"
Martin Geisler <mg@aragost.com>
parents:
11937
diff
changeset
|
384 :hg:`update`. The creation of a tag is stored in the history and |
c3f2152e423d
glossary: add entry for "Tag"
Martin Geisler <mg@aragost.com>
parents:
11937
diff
changeset
|
385 will thus automatically be shared with other using push and pull. |
c3f2152e423d
glossary: add entry for "Tag"
Martin Geisler <mg@aragost.com>
parents:
11937
diff
changeset
|
386 |
11356 | 387 Tip |
388 The changeset with the highest revision number. It is the changeset | |
389 most recently added in a repository. | |
390 | |
391 Tip, branch | |
392 The head of a given branch with the highest revision number. When | |
393 a branch name is used as a revision identifier, it refers to the | |
394 branch tip. See also 'Branch, head'. Note that because revision | |
395 numbers may be different in different repository clones, the | |
396 branch tip may be different in different cloned repositories. | |
397 | |
398 Update | |
399 (Noun) Another synonym of changeset. | |
400 | |
11437
9fa255c32406
help: glossary.txt formatting fixes
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
11436
diff
changeset
|
401 Example: "I've pushed an update". |
11356 | 402 |
403 (Verb) This term is usually used to describe updating the state of | |
404 the working directory to that of a specific changeset. See | |
405 :hg:`help update`. | |
406 | |
407 Example: "You should update". | |
408 | |
409 Working directory | |
410 See 'Directory, working'. | |
411 | |
412 Working directory parent | |
11437
9fa255c32406
help: glossary.txt formatting fixes
Wagner Bruna <wbruna@softwareexpress.com.br>
parents:
11436
diff
changeset
|
413 See 'Parent, working directory'. |